org.apache.openejb.server.discovery

Class MulticastPulseAgent

java.lang.Object

org.apache.openejb.server.discovery.MulticastPulseAgent

All Implemented Interfaces:

DiscoveryAgent, SelfManaging, ServerService, org.apache.openejb.spi.Service

public class MulticastPulseAgent
extends Object
implements DiscoveryAgent, ServerService, SelfManaging

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT
static String	EMPTY
static String	SERVER

Constructor Summary

Constructors

Constructor and Description
MulticastPulseAgent() This agent listens for client pulses on a defined multicast channel.

Method Summary

Methods

Modifier and Type	Method and Description
String	getIP()
String	getName()
int	getPort()
static MulticastSocket[]	getSockets(String multicastAddress, int port) Attempts to return at least one socket per valid network interface.
void	init(Properties p)
static boolean	isLocalAddress(String host, boolean wildcardIsLocal) Is the provided host a local host
static boolean	isLoopback(String host) Is the provided host a valid loopback address
void	registerService(URI uri)
void	reportFailed(URI serviceUri)
void	service(InputStream in, OutputStream out)
void	service(Socket socket)
void	setDiscoveryListener(DiscoveryListener listener)
void	start()
void	stop()
void	unregisterService(URI uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER

public static final String SERVER

See Also:

Constant Field Values

CLIENT

public static final String CLIENT

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

See Also:

Constant Field Values

Constructor Detail

MulticastPulseAgent

public MulticastPulseAgent()

This agent listens for client pulses on a defined multicast channel. On receipt of a valid pulse the agent responds with its own pulse for a defined amount of time and rate. A client can deliver a pulse as often as required until it is happy of the server response.

Both server and client deliver crafted information payloads.

Method Detail

init

public void init(Properties p)
          throws Exception

Specified by:

init in interface org.apache.openejb.spi.Service

Throws:

Exception

setDiscoveryListener

public void setDiscoveryListener(DiscoveryListener listener)

Specified by:

setDiscoveryListener in interface DiscoveryAgent

registerService

public void registerService(URI uri)
                     throws IOException

Specified by:

registerService in interface DiscoveryAgent

Throws:

IOException

unregisterService

public void unregisterService(URI uri)
                       throws IOException

Specified by:

unregisterService in interface DiscoveryAgent

Throws:

IOException

reportFailed

public void reportFailed(URI serviceUri)
                  throws IOException

Specified by:

reportFailed in interface DiscoveryAgent

Throws:

IOException

start

public void start()
           throws ServiceException

Specified by:

start in interface ServerService

Throws:

ServiceException

stop

public void stop()
          throws ServiceException

Specified by:

stop in interface ServerService

Throws:

ServiceException

service

public void service(InputStream in,
           OutputStream out)
             throws ServiceException,
                    IOException

Specified by:

service in interface ServerService

Throws:

ServiceException

IOException

service

public void service(Socket socket)
             throws ServiceException,
                    IOException

Specified by:

service in interface ServerService

Throws:

ServiceException

IOException

getName

public String getName()

Specified by:

getName in interface ServerService

getIP

public String getIP()

Specified by:

getIP in interface ServerService

getPort

public int getPort()

Specified by:

getPort in interface ServerService

getSockets

public static MulticastSocket[] getSockets(String multicastAddress,
                           int port)
                                    throws Exception

Attempts to return at least one socket per valid network interface. If no valid interface is found then the array will be empty.

Parameters:

multicastAddress - A valid multicast address

port - A valid multicast port

Returns:

MulticastSocket[], may be empty if no valid interfaces exist

Throws:

Exception - On invalid parameters

isLoopback

public static boolean isLoopback(String host)

Is the provided host a valid loopback address

Parameters:

host - Host to test

Returns:

True or false

isLocalAddress

public static boolean isLocalAddress(String host,
                     boolean wildcardIsLocal)

Is the provided host a local host

Parameters:

host - The host to test

wildcardIsLocal - Should 0.0.0.0 or [::] be deemed as local

Returns:

True is the host is a local host else false