|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGenericServerContainerGroup
Generic server container group. Instances of this type are returned from using the IGenericServerContainerGroupFactory
service.
Field Summary | |
---|---|
static int |
DEFAULT_KEEPALIVE
|
Method Summary | |
---|---|
void |
close()
Close this generic server container group. |
ISharedObjectContainer |
createContainer(java.lang.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(java.lang.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(java.lang.String path,
int keepAlive,
java.util.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. |
ISharedObjectContainer |
getContainer(java.lang.String path)
Get the container instance associated with the given path. |
java.util.Map |
getContainers()
Get a map (String->ISharedObjectContainer) of the path->containers previously created. |
java.net.URI |
getGroupEndpoint()
Get the URI for the group endpoint. |
boolean |
isListening()
Returns true if this container group previously started listening via a successful call to startListening() ). |
ISharedObjectContainer |
removeContainer(java.lang.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. |
Field Detail |
---|
static final int DEFAULT_KEEPALIVE
Method Detail |
---|
java.net.URI getGroupEndpoint()
ISharedObjectContainer createContainer(java.lang.String path, int keepAlive, java.util.Map properties) throws ContainerCreateException
path
- the uri path suffix for defining the container's identity. For example, if 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.
null
.
ContainerCreateException
- if container with given path, keepAlive, and properties could not be created.ISharedObjectContainer createContainer(java.lang.String path, int keepAlive) throws ContainerCreateException
path
- the uri path suffix for defining the container's identity. For example, if 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.
null
.
ContainerCreateException
- if container with given path, keepAlive, and properties could not be created.ISharedObjectContainer createContainer(java.lang.String path) throws ContainerCreateException
path
- the uri path suffix for defining the container's identity. For example, if 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
.
null
.
ContainerCreateException
- if container with given path, keepAlive, and properties could not be created.ISharedObjectContainer getContainer(java.lang.String path)
path
- of the container to return. Must not be null
.
java.util.Map getContainers()
null
, but
may return a Map of size==0.ISharedObjectContainer removeContainer(java.lang.String path)
path
- of the shared object container to remove.
null
will be returned.void startListening() throws java.io.IOException
java.io.IOException
- if the server port cannot be opened for listening.IGenericServerContainerGroupFactory.createContainerGroup(String, int, Map)
boolean isListening()
true
if this container group previously started listening via a successful call to startListening()
).
true
if currently listening, false
otherwise.void stopListening()
void close()
createContainer(String, int, Map)
within this group, and for each one:IContainer.dispose()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |