|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProtocolService
Minimum functionality required by an ApacheDS protocol service.
Method Summary | |
---|---|
DatagramAcceptor |
getDatagramAcceptor()
If this protocol service supports UDP transport then this gets the non-null MINA DatagramAcceptor it uses. |
DirectoryService |
getDirectoryService()
Gets the DirectoryService assigned to this ProtocolService. |
java.lang.String |
getIpAddress()
Gets the IP address of this service. |
int |
getIpPort()
Gets the IP port for this service. |
java.lang.String |
getServiceId()
Gets the instance identifier for this ProtocolService. |
java.lang.String |
getServiceName()
Gets a descriptive name for the kind of service this represents. |
SocketAcceptor |
getSocketAcceptor()
If this protocol service support TCP transport then this gets the MINA SocketAcceptor it uses. |
java.util.Set<TransportProtocol> |
getTransportProtocols()
Gets the transport protocols used by this service. |
boolean |
isEnabled()
Services can be enabled or disabled. |
boolean |
isStarted()
Gets whether or not this service has been started. |
void |
setDatagramAcceptor(DatagramAcceptor datagramAcceptor)
If this protocol service supports UDP transport then this sets the MINA DatagramAcceptor it uses. |
void |
setDirectoryService(DirectoryService directoryService)
Sets the DirectoryService assigned to this ProtocolService. |
void |
setEnabled(boolean enabled)
Sets whether or not this ProtocolService is enabled. |
void |
setIpAddress(java.lang.String ipAddress)
Gets the IP address of this service. |
void |
setIpPort(int ipPort)
Sets the IP port for this service. |
void |
setServiceId(java.lang.String serviceId)
Sets the instance identifier for this ProtocolService. |
void |
setServiceName(java.lang.String name)
Sets the descriptive name for the kind of service this represents. |
void |
setSocketAcceptor(SocketAcceptor socketAcceptor)
If this protocol service support TCP transport then this sets the MINA SocketAcceptor it uses. |
void |
setTransportProtocols(java.util.Set<TransportProtocol> transportProtocols)
Sets the transport protocols used by this service. |
void |
start()
Starts this ProtocolService which binds acceptors on the protocol port. |
void |
stop()
Stops this ProtocolService which unbinds acceptors on the protocol port. |
Method Detail |
---|
void stop() throws java.lang.Exception
java.lang.Exception
- if there are problems stopping this servicevoid start() throws java.lang.Exception
java.lang.Exception
- if there are problems starting this serviceboolean isStarted()
DatagramAcceptor getDatagramAcceptor()
void setDatagramAcceptor(DatagramAcceptor datagramAcceptor)
datagramAcceptor
- the MINA DatagramAcceptor used for UDP transportSocketAcceptor getSocketAcceptor()
void setSocketAcceptor(SocketAcceptor socketAcceptor)
socketAcceptor
- the MINA SocketAcceptor used for TCP transportboolean isEnabled()
void setEnabled(boolean enabled)
enabled
- true to enable, false to disablejava.lang.String getServiceId()
void setServiceId(java.lang.String serviceId)
serviceId
- an identifier for the service instancejava.lang.String getServiceName()
void setServiceName(java.lang.String name)
name
- a descriptive name for the kind of this servicejava.lang.String getIpAddress()
void setIpAddress(java.lang.String ipAddress)
ipAddress
- the Internet Protocol address for this service.int getIpPort()
void setIpPort(int ipPort)
ipPort
- the ip port for this service
java.lang.IllegalArgumentException
- if the port number is not within a valid rangejava.util.Set<TransportProtocol> getTransportProtocols()
void setTransportProtocols(java.util.Set<TransportProtocol> transportProtocols)
transportProtocols
- the transport protocols to be used by this serviceDirectoryService getDirectoryService()
void setDirectoryService(DirectoryService directoryService)
directoryService
- the directory service core assigned to this service
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |