org.jSyncManager.SJS
Interface ServerRemoteInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

Server

public interface ServerRemoteInterface
extends java.rmi.Remote

An interface to define the remotely accessable methods for manipulating the server. This interface is implemented by the Server class in order to permit the specified methods to be callable by an RMI-based client application.

Version:

0.1

Author:

Brad BARCLAY <bbarclay@jsyncmanager.org>

Method Summary

void	acceptAllIncomingRequests() Causes the server to accept all incoming requests in all services.
void	acceptIncomingRequests(java.net.SocketAddress address) A method to accept incoming requests to the specified service.
void	acceptIncomingRequests(java.lang.String serviceName) A method to accept incoming requests to the specified service.
void	acceptIncomingRequests(java.lang.String address, int port) A method to accept incoming requests to the specified service.
void	createService(java.lang.String name, java.net.SocketAddress address, java.lang.String adapterName) Creates the specified service.
void	createService(java.lang.String name, java.lang.String address, int port, java.lang.String adapterName) Creates the specified service.
void	denyAllIncomingRequests() Causes the server to deny all incoming requests in all services.
void	denyIncomingRequests(java.net.SocketAddress address) A method to deny incoming requests to the specified service.
void	denyIncomingRequests(java.lang.String serviceName) A method to deny incoming requests to the specified service.
void	denyIncomingRequests(java.lang.String address, int port) A method to deny incoming requests to the specified service.
java.lang.String	describeAllServices() Describes all the services running on this server.
java.lang.String	describeAllServicesWithParameter(java.lang.String param) Describes all the services with the specified parameter running on this server.
java.lang.String	describeService(java.net.SocketAddress address) A method to describe the specified service.
java.lang.String	describeService(java.lang.String serviceName) A method to describe the specified service.
java.lang.String	describeService(java.lang.String address, int port) A method to describe the specified service.
java.lang.String	describeServiceParameter(java.net.SocketAddress address, java.lang.String param) A method to describe the specified service parameter.
java.lang.String	describeServiceParameter(java.lang.String address, int port, java.lang.String param) A method to describe the specified service parameter.
java.lang.String	describeServiceParameter(java.lang.String serviceName, java.lang.String param) A method to describe the specified service parameter.
java.lang.String	getAllStatus() Retrieves the status for all services running on this server.
java.lang.String	getStatus(java.net.SocketAddress address) A method to query the status of the specified service.
java.lang.String	getStatus(java.lang.String serviceName) A method to query the status of the specified service.
java.lang.String	getStatus(java.lang.String address, int port) A method to query the status of the specified service.
void	removeAllServices() Removes all services from the server.
void	removeParameterInAllServices(java.lang.String param) A method to remove the specified parameter from all services.
void	removeService(java.net.SocketAddress address) A method to remove the specified service.
void	removeService(java.lang.String serviceName) A method to remove the specified service.
void	removeService(java.lang.String address, int port) A method to remove the specified service.
void	removeServiceParameter(java.net.SocketAddress address, java.lang.String param) A method to remove the specified service.
void	removeServiceParameter(java.lang.String address, int port, java.lang.String param) A method to remove the specified service parameter.
void	removeServiceParameter(java.lang.String serviceName, java.lang.String param) A method to remove the specified service parameter.
void	setParameterInAllServices(java.lang.String param, java.lang.String value) Sets the specified parameter to the specified value in all services running on this system.
void	setServiceParameter(java.net.SocketAddress address, java.lang.String param, java.lang.String value) A method to set the specified service parameter.
void	setServiceParameter(java.lang.String address, int port, java.lang.String param, java.lang.String value) A method to set the specified service parameter.
void	setServiceParameter(java.lang.String serviceName, java.lang.String param, java.lang.String value) A method to set the specified service parameter.
void	shutdownNicely() A method to shutdown the entire Internet Service Server as soon as all existing connections have ended.
void	shutdownNow() A method to shutdown the entire Internet Service Server immediately.

Method Detail

describeService

java.lang.String describeService(java.lang.String address,
                                 int port)
                                 throws java.rmi.RemoteException,
                                        java.net.UnknownHostException,
                                        ConnectionManagerNotFoundException

A method to describe the specified service.

Parameters:

address - the host name or IP address the service to describe is bound to.

port - the port the service to describe is bound to.

Returns:

a String describing the service requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

describeService

java.lang.String describeService(java.lang.String serviceName)
                                 throws java.rmi.RemoteException,
                                        ConnectionManagerNotFoundException

A method to describe the specified service.

Parameters:

serviceName - the service to be described.

Returns:

a String describing the service requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

describeService

java.lang.String describeService(java.net.SocketAddress address)
                                 throws java.rmi.RemoteException,
                                        ConnectionManagerNotFoundException

A method to describe the specified service.

Parameters:

address - the SocketAddress of the service to be described.

Returns:

a String describing the service requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

describeServiceParameter

java.lang.String describeServiceParameter(java.lang.String address,
                                          int port,
                                          java.lang.String param)
                                          throws java.rmi.RemoteException,
                                                 java.net.UnknownHostException,
                                                 ConnectionManagerNotFoundException

A method to describe the specified service parameter.

Parameters:

address - the host name or IP address the service to describe is bound to.

port - the port the service to describe is bound to.

param - the name of the parameter to query.

Returns:

a String describing the service parameter requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

describeServiceParameter

java.lang.String describeServiceParameter(java.lang.String serviceName,
                                          java.lang.String param)
                                          throws java.rmi.RemoteException,
                                                 ConnectionManagerNotFoundException

A method to describe the specified service parameter.

Parameters:

serviceName - the name of the service to query.

param - the name of the parameter to query.

Returns:

a String describing the service parameter requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

describeServiceParameter

java.lang.String describeServiceParameter(java.net.SocketAddress address,
                                          java.lang.String param)
                                          throws java.rmi.RemoteException,
                                                 ConnectionManagerNotFoundException

A method to describe the specified service parameter.

Parameters:

address - the SocketAddress the service to query is bound to.

param - the name of the parameter to query.

Returns:

a String describing the service parameter requested.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

denyIncomingRequests

void denyIncomingRequests(java.net.SocketAddress address)
                          throws java.rmi.RemoteException,
                                 ConnectionManagerNotFoundException

A method to deny incoming requests to the specified service.

Parameters:

address - the SocketAddress the service to query is bound to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

denyIncomingRequests

void denyIncomingRequests(java.lang.String serviceName)
                          throws java.rmi.RemoteException,
                                 ConnectionManagerNotFoundException

A method to deny incoming requests to the specified service.

Parameters:

serviceName - the name of the service to query.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

denyIncomingRequests

void denyIncomingRequests(java.lang.String address,
                          int port)
                          throws java.rmi.RemoteException,
                                 java.net.UnknownHostException,
                                 ConnectionManagerNotFoundException

A method to deny incoming requests to the specified service.

Parameters:

address - the hostname or IP address of the service to process.

port - the port the service to describe is bound to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

acceptIncomingRequests

void acceptIncomingRequests(java.net.SocketAddress address)
                            throws java.rmi.RemoteException,
                                   ConnectionManagerNotFoundException,
                                   ServiceAlreadyRunningException

A method to accept incoming requests to the specified service.

Parameters:

address - the hostname or IP address of the service to process.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

ServiceAlreadyRunningException - if the specified service is already running.

acceptIncomingRequests

void acceptIncomingRequests(java.lang.String serviceName)
                            throws java.rmi.RemoteException,
                                   ConnectionManagerNotFoundException,
                                   ServiceAlreadyRunningException

A method to accept incoming requests to the specified service.

Parameters:

serviceName - the name of the service to process.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

ServiceAlreadyRunningException - if the specified service is already running.

acceptIncomingRequests

void acceptIncomingRequests(java.lang.String address,
                            int port)
                            throws java.rmi.RemoteException,
                                   java.net.UnknownHostException,
                                   ConnectionManagerNotFoundException,
                                   ServiceAlreadyRunningException

A method to accept incoming requests to the specified service.

Parameters:

address - the hostname or IP address of the service to process.

port - the port the service to describe is bound to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

ServiceAlreadyRunningException - if the specified service is already running.

getStatus

java.lang.String getStatus(java.net.SocketAddress address)
                           throws java.rmi.RemoteException,
                                  ConnectionManagerNotFoundException

A method to query the status of the specified service.

Parameters:

address - the hostname or IP address of the service to process.

Returns:

the status of the specified service.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

getStatus

java.lang.String getStatus(java.lang.String serviceName)
                           throws java.rmi.RemoteException,
                                  ConnectionManagerNotFoundException

A method to query the status of the specified service.

Parameters:

serviceName - the name of the service to process.

Returns:

the status of the specified service.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

getStatus

java.lang.String getStatus(java.lang.String address,
                           int port)
                           throws java.rmi.RemoteException,
                                  java.net.UnknownHostException,
                                  ConnectionManagerNotFoundException

A method to query the status of the specified service.

Parameters:

address - the binding address of the service to process.

port - the port the service to describe is bound to.

Returns:

the status of the specified service.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

shutdownNow

void shutdownNow()
                 throws java.rmi.RemoteException

A method to shutdown the entire Internet Service Server immediately.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

shutdownNicely

void shutdownNicely()
                    throws java.rmi.RemoteException

A method to shutdown the entire Internet Service Server as soon as all existing connections have ended.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

setServiceParameter

void setServiceParameter(java.lang.String address,
                         int port,
                         java.lang.String param,
                         java.lang.String value)
                         throws java.rmi.RemoteException,
                                java.net.UnknownHostException,
                                ConnectionManagerNotFoundException

A method to set the specified service parameter.

Parameters:

address - the host name or IP address the service to describe is bound to.

port - the port the service to describe is bound to.

param - the name of the parameter to query.

value - the value to set the parameter to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

setServiceParameter

void setServiceParameter(java.lang.String serviceName,
                         java.lang.String param,
                         java.lang.String value)
                         throws java.rmi.RemoteException,
                                ConnectionManagerNotFoundException

A method to set the specified service parameter.

Parameters:

serviceName - the name of the service to query.

param - the name of the parameter to query.

value - the value to set the parameter to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

setServiceParameter

void setServiceParameter(java.net.SocketAddress address,
                         java.lang.String param,
                         java.lang.String value)
                         throws java.rmi.RemoteException,
                                ConnectionManagerNotFoundException

A method to set the specified service parameter.

Parameters:

address - the SocketAddress the service to query is bound to.

param - the name of the parameter to query.

value - the value to set the parameter to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

createService

void createService(java.lang.String name,
                   java.lang.String address,
                   int port,
                   java.lang.String adapterName)
                   throws java.rmi.RemoteException,
                          java.lang.ClassNotFoundException,
                          java.net.UnknownHostException

Creates the specified service.

Parameters:

name - the name to assign to the service.

address - the IP address to bind to.

port - the port to listen to.

adapterName - the classname of the adapter to use.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.lang.ClassNotFoundException - if the specified adapter cannot be found.

java.net.UnknownHostException - if the specified hostname is unknown.

createService

void createService(java.lang.String name,
                   java.net.SocketAddress address,
                   java.lang.String adapterName)
                   throws java.rmi.RemoteException,
                          java.lang.ClassNotFoundException

Creates the specified service.

Parameters:

name - the name to assign to the service.

address - the SocketAddress object to bind to.

adapterName - the classname of the adapter to use.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.lang.ClassNotFoundException - if the specified adapter cannot be found.

describeAllServices

java.lang.String describeAllServices()
                                     throws java.rmi.RemoteException

Describes all the services running on this server.

Returns:

returned

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

getAllStatus

java.lang.String getAllStatus()
                              throws java.rmi.RemoteException

Retrieves the status for all services running on this server.

Returns:

returned

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

describeAllServicesWithParameter

java.lang.String describeAllServicesWithParameter(java.lang.String param)
                                                  throws java.rmi.RemoteException

Describes all the services with the specified parameter running on this server.

Parameters:

param - the name of the parameter to describe.

Returns:

returned

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

setParameterInAllServices

void setParameterInAllServices(java.lang.String param,
                               java.lang.String value)
                               throws java.rmi.RemoteException

Sets the specified parameter to the specified value in all services running on this system.

Parameters:

param - the name of the parameter to be set.

value - the value to set the parameter to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

denyAllIncomingRequests

void denyAllIncomingRequests()
                             throws java.rmi.RemoteException

Causes the server to deny all incoming requests in all services.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

acceptAllIncomingRequests

void acceptAllIncomingRequests()
                               throws java.rmi.RemoteException

Causes the server to accept all incoming requests in all services.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

removeService

void removeService(java.lang.String address,
                   int port)
                   throws java.rmi.RemoteException,
                          java.net.UnknownHostException,
                          ConnectionManagerNotFoundException

A method to remove the specified service.

Parameters:

address - the host name or IP address the service to remove is bound to.

port - the port the service to remove is bound to.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeService

void removeService(java.lang.String serviceName)
                   throws java.rmi.RemoteException,
                          ConnectionManagerNotFoundException

A method to remove the specified service.

Parameters:

serviceName - the service to be removed.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeService

void removeService(java.net.SocketAddress address)
                   throws java.rmi.RemoteException,
                          ConnectionManagerNotFoundException

A method to remove the specified service.

Parameters:

address - the SocketAddress of the service to be removed.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeServiceParameter

void removeServiceParameter(java.lang.String address,
                            int port,
                            java.lang.String param)
                            throws java.rmi.RemoteException,
                                   java.net.UnknownHostException,
                                   ConnectionManagerNotFoundException

A method to remove the specified service parameter.

Parameters:

address - the host name or IP address the service to remove the parameter from is bound to.

port - the port the service to remove is bound to.

param - parameter value

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

java.net.UnknownHostException - if the specified hostname is unknown.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeServiceParameter

void removeServiceParameter(java.lang.String serviceName,
                            java.lang.String param)
                            throws java.rmi.RemoteException,
                                   ConnectionManagerNotFoundException

A method to remove the specified service parameter.

Parameters:

serviceName - the service to remove the parameter from.

param - parameter value

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeServiceParameter

void removeServiceParameter(java.net.SocketAddress address,
                            java.lang.String param)
                            throws java.rmi.RemoteException,
                                   ConnectionManagerNotFoundException

A method to remove the specified service.

Parameters:

address - the SocketAddress of the service to remove the parameter from.

param - parameter value

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

ConnectionManagerNotFoundException - if the requested service can't be found.

removeAllServices

void removeAllServices()
                       throws java.rmi.RemoteException

Removes all services from the server.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.

removeParameterInAllServices

void removeParameterInAllServices(java.lang.String param)
                                  throws java.rmi.RemoteException

A method to remove the specified parameter from all services.

Parameters:

param - the parameter to be removed from all services.

Throws:

java.rmi.RemoteException - if an RMI communication problem is encountered.