org.eclipse.ecf.server.generic

Class GenericServerContainerGroup

java.lang.Object

org.eclipse.ecf.server.generic.GenericServerContainerGroup

All Implemented Interfaces:

IGenericServerContainerGroup

public class GenericServerContainerGroup
extends Object
implements IGenericServerContainerGroup

Since:

4.0

Field Summary

Fields inherited from interface org.eclipse.ecf.server.generic.IGenericServerContainerGroup

DEFAULT_KEEPALIVE

Constructor Summary

Constructors

Constructor and Description
GenericServerContainerGroup(String hostname, int port, InetAddress bindAddress, Map defaultContainerProperties)
GenericServerContainerGroup(String hostname, int port, Map defaultContainerProperties)

Method Summary

Modifier and Type	Method and Description
void	close() Close this generic server container group.
ISharedObjectContainer	createContainer(String path) Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.
ISharedObjectContainer	createContainer(String path, int keepAlive) Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.
ISharedObjectContainer	createContainer(String path, int keepAlive, Map properties) Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.
protected TCPServerSOContainer	createGenericServerContainer(String path, int keepAlive, Map properties)
protected ID	createGenericServerID(String path, Map properties)
protected Map	createGenericServerProperties(String path, Map properties)
ISharedObjectContainer	getContainer(String path) Get the container instance associated with the given path.
Map	getContainers() Get a map (String->ISharedObjectContainer) of the path->containers previously created.
URI	getGroupEndpoint() Get the URI for the group endpoint.
protected TCPServerSOContainerGroup	getServerGroup()
boolean	isListening() Returns true if this container group previously started listening via a successful call to IGenericServerContainerGroup.startListening()).
boolean	isSSLTransport()
ISharedObjectContainer	removeContainer(String path) Remove previously created container with given path.
void	startListening() Start listening on the port given to this generic server container group upon creation.
void	stopListening() Stop listening on port given to this generic server container group upon creation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericServerContainerGroup

public GenericServerContainerGroup(String hostname,
                                   int port,
                                   Map defaultContainerProperties)

GenericServerContainerGroup

public GenericServerContainerGroup(String hostname,
                                   int port,
                                   InetAddress bindAddress,
                                   Map defaultContainerProperties)

Since:

7.0

Method Detail

getContainers

public Map getContainers()

Description copied from interface: IGenericServerContainerGroup

Get a map (String->ISharedObjectContainer) of the path->containers previously created.

Specified by:

getContainers in interface IGenericServerContainerGroup

Returns:

map of the path->container map for this generic server container group. Will not return null, but may return a Map of size==0.

createContainer

public ISharedObjectContainer createContainer(String path,
                                              int keepAlive,
                                              Map properties)
                                       throws ContainerCreateException

Description copied from interface: IGenericServerContainerGroup

Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.

Specified by:

createContainer in interface IGenericServerContainerGroup

Parameters:

path - the uri path suffix for defining the container's identity. For example, if IGenericServerContainerGroup.getGroupEndpoint() returns 'ecftcp://localhost:3282', and a path of '/server' is used to create a new container, then the container's id will be 'ecftcp://localhost:3282/server'. Must not be null.

keepAlive - a value (in milliseconds) that defines the keepAlive for the resulting container.

properties - to be associated to the returned container upon instantiation.

Returns:

shared object container. Will not be null.

Throws:

ContainerCreateException - if container with given path, keepAlive, and properties could not be created.

createContainer

public ISharedObjectContainer createContainer(String path,
                                              int keepAlive)
                                       throws ContainerCreateException

Description copied from interface: IGenericServerContainerGroup

Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.

Specified by:

createContainer in interface IGenericServerContainerGroup

Parameters:

path - the uri path suffix for defining the container's identity. For example, if IGenericServerContainerGroup.getGroupEndpoint() returns 'ecftcp://localhost:3282', and a path of '/server' is used to create a new container, then the container's id will be 'ecftcp://localhost:3282/server'. Must not be null.

keepAlive - a value (in milliseconds) that defines the keepAlive for the resulting container.

Returns:

shared object container. Will not be null.

Throws:

ContainerCreateException - if container with given path, keepAlive, and properties could not be created.

createContainer

public ISharedObjectContainer createContainer(String path)
                                       throws ContainerCreateException

Description copied from interface: IGenericServerContainerGroup

Create a shared object container within this container group, given a path, a keepAlive value, and a Map of properties that will be provided to the created container.

Specified by:

createContainer in interface IGenericServerContainerGroup

Parameters:

path - the uri path suffix for defining the container's identity. For example, if IGenericServerContainerGroup.getGroupEndpoint() returns 'ecftcp://localhost:3282', and a path of '/server' is used to create a new container, then the container's id will be 'ecftcp://localhost:3282/server'. Must not be null.

Returns:

shared object container. Will not be null.

Throws:

ContainerCreateException - if container with given path, keepAlive, and properties could not be created.

getServerGroup

protected TCPServerSOContainerGroup getServerGroup()

Since:

6.0

createGenericServerContainer

protected TCPServerSOContainer createGenericServerContainer(String path,
                                                            int keepAlive,
                                                            Map properties)
                                                     throws ContainerCreateException

Throws:

ContainerCreateException

createGenericServerProperties

protected Map createGenericServerProperties(String path,
                                            Map properties)

createGenericServerID

protected ID createGenericServerID(String path,
                                   Map properties)
                            throws ContainerCreateException

Throws:

ContainerCreateException

getContainer

public ISharedObjectContainer getContainer(String path)

Description copied from interface: IGenericServerContainerGroup

Get the container instance associated with the given path.

Specified by:

getContainer in interface IGenericServerContainerGroup

Parameters:

path - of the container to return. Must not be null.

Returns:

the previously created shared object container associated with the given path.

removeContainer

public ISharedObjectContainer removeContainer(String path)

Description copied from interface: IGenericServerContainerGroup

Remove previously created container with given path.

Specified by:

removeContainer in interface IGenericServerContainerGroup

Parameters:

path - of the shared object container to remove.

Returns:

shared object container removed. If no shared object container was previously created with the given path, then null will be returned.

startListening

public void startListening()
                    throws IOException

Description copied from interface: IGenericServerContainerGroup

Start listening on the port given to this generic server container group upon creation.

Specified by:

startListening in interface IGenericServerContainerGroup

Throws:

IOException - if the server port cannot be opened for listening.

See Also:

IGenericServerContainerGroupFactory.createContainerGroup(String, int, Map)

isListening

public boolean isListening()

Description copied from interface: IGenericServerContainerGroup

Returns true if this container group previously started listening via a successful call to IGenericServerContainerGroup.startListening()).

Specified by:

isListening in interface IGenericServerContainerGroup

Returns:

true if currently listening, false otherwise.

stopListening

public void stopListening()

Description copied from interface: IGenericServerContainerGroup

Stop listening on port given to this generic server container group upon creation.

Specified by:

stopListening in interface IGenericServerContainerGroup

close

public void close()

Description copied from interface: IGenericServerContainerGroup

Close this generic server container group. This method will:

1. iterate through all containers created via IGenericServerContainerGroup.createContainer(String, int, Map) within this group, and for each one:
1. remove it from the set of containers within this group
2. call IContainer.dispose()
2. stop listening on the port given to this generic server container group upon creation.

Specified by:

close in interface IGenericServerContainerGroup

getGroupEndpoint

public URI getGroupEndpoint()

Description copied from interface: IGenericServerContainerGroup

Get the URI for the group endpoint. For

Specified by:

getGroupEndpoint in interface IGenericServerContainerGroup

Returns:

uri that is the group endpoint. For example uri='ecftcp://localhost:3282'

isSSLTransport

public boolean isSSLTransport()

Specified by:

isSSLTransport in interface IGenericServerContainerGroup

Since:

6.0