com.adventnet.adaptors
Interface Adaptor

All Known Implementing Classes:

AbstractAdaptor, CorbaAdaptor, HtmlAdaptor, HttpConnector, RMIAdaptor, SnmpAdaptor, TL1Adaptor

public interface Adaptor

This interface is implemented by all Protocol adaptors (RMI,CORBA,HTTP,HTML,SNMP) This interface essentialy defines the management functions of the adaptor

Since:

Adaptor Version 2.0

See Also:

com.adventnet.adaptor.AbstractAdaptor, com.adventnet.adaptor.Protocol

Method Summary

void	enableAuthentication(boolean flag) This method can be used to enable or disable Authentication
void	enableAuthorisation(boolean flag) This method can be used to enable or disable Authorisation
javax.management.ObjectName	getAdaptorObjectName() This method returns the Adaptors Object Name
java.lang.String	getAdaptorVersion() This method returns the Adaptors Version
java.lang.String	getHost() This method returns the host on which the Adaptor resides
int	getPort() This method returns the port on which the Adaptor is listening
java.lang.String	getProtocol() This method Returns the Protocol associated with this Adaptor
int	getState() This method returns the state of the Adaptor
java.lang.String	getStateInString() This method returns the state of the Adaptor in String format
boolean	isActive() This method checks if the Adaptor is in STARTING or STARTED state
boolean	isSecure() This method checks if the communication is secure
void	setPort(int port) This method sets the port number of on which the adaptor should listen
void	startService() This method starts the Adaptor
void	stopService() This method stops the Adaptor

Method Detail

getHost

java.lang.String getHost()

This method returns the host on which the Adaptor resides

getPort

int getPort()

This method returns the port on which the Adaptor is listening

getProtocol

java.lang.String getProtocol()

This method Returns the Protocol associated with this Adaptor

getState

int getState()

This method returns the state of the Adaptor

getStateInString

java.lang.String getStateInString()

This method returns the state of the Adaptor in String format

setPort

void setPort(int port)
             throws java.lang.IllegalStateException

This method sets the port number of on which the adaptor should listen

Throws:

java.lang.IllegalStateException - if the Adaptor is STARTING or STARTED state

isActive

boolean isActive()

This method checks if the Adaptor is in STARTING or STARTED state

isSecure

boolean isSecure()

This method checks if the communication is secure

enableAuthentication

void enableAuthentication(boolean flag)
                          throws java.lang.UnsupportedOperationException

This method can be used to enable or disable Authentication

Throws:

java.lang.UnsupportedOperationException

enableAuthorisation

void enableAuthorisation(boolean flag)
                         throws java.lang.UnsupportedOperationException

This method can be used to enable or disable Authorisation

Throws:

java.lang.UnsupportedOperationException

startService

void startService()
                  throws java.lang.IllegalStateException,
                         java.lang.Exception

This method starts the Adaptor

Throws:

java.lang.IllegalStateException - if the Adaptor is in STARTING or STARTED state

java.lang.Exception

stopService

void stopService()
                 throws java.lang.IllegalStateException

This method stops the Adaptor

Throws:

java.lang.IllegalStateException - if the Adaptor is in STOPPING or STOPPED state

getAdaptorVersion

java.lang.String getAdaptorVersion()

This method returns the Adaptors Version

getAdaptorObjectName

javax.management.ObjectName getAdaptorObjectName()

This method returns the Adaptors Object Name