|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.adventnet.adaptors.AbstractAdaptor
This abstract class abstracts the common behaviour of all Adaptors. All Protocol Adaptors must extend this class .
com.adventnet.adaptor.Adaptor
,
com.adventnet.adaptor.Protocol
, Serialized FormField Summary | |
protected int |
port
|
protected int |
state
|
Constructor Summary | |
AbstractAdaptor()
|
Method Summary | |
void |
addNotificationListener(NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
This method can be used to Add a Notification Listener for this Adaptor |
protected abstract void |
bind()
Must be used to bind to a naming service or to bind to a ServerSocket |
void |
changeState(int i)
This method changes the state of the adaptor |
protected abstract void |
destroyAdaptor()
Kills the adaptor and releases all its resources |
abstract void |
enableAuthentication(boolean flag)
This abstract method needs to be implemented by the Adaptor for providing Authentication |
abstract void |
enableAuthorisation(boolean flag)
This abstract method needs to be implemented by the Adaptor for providing Authorisation |
abstract ObjectName |
getAdaptorObjectName()
Returns the adaptor object name |
java.lang.String |
getAdaptorVersion()
Returns the adaptor version implemented by this Adaptor |
java.lang.String |
getHost()
This method returns the host on which the adaptor resides |
MBeanNotificationInfo[] |
getNotificationInfo()
This method returns the NotificationInfo |
int |
getPort()
This method returns the port on which the adaptor listens |
abstract java.lang.String |
getProtocol()
This abstract method returns the Protocol on which the adaptor is listening |
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 |
protected abstract void |
instantiateAdaptor()
Must be implemented by the adaptor and should be used to instantiate itsefl |
boolean |
isActive()
This method returns true if the Adaptor is in STARTING or STARTED state |
boolean |
isSecure()
Default returns false . |
void |
postDeregister()
This method must be implemented by the Adaptor if it wants to perform any Post Deregistration tasks |
void |
postRegister(java.lang.Boolean registrationDone)
This method must be overridden by the Adaptor if the Adaptor wants to perform any Post Registration tasks |
void |
preDeregister()
This method must be overridden by the Adaptor if it wants to perform any Pre Deregistration tasks |
ObjectName |
preRegister(MBeanServer mbeanServer,
ObjectName objectName)
This method must be overriden by the Adaptor if the Adaptor wants to perform any Pre registration tasks |
void |
removeNotificationListener(NotificationListener listener)
This method removes the Notification Listeners |
void |
setPort(int port)
This method sets the port on which this adaptor is listening |
void |
startService()
This method starts the Adaptor service |
void |
stopService()
This method stops the Adaptor |
protected abstract void |
unbind()
Must be used to unbind from a naming service or to relese a ServerSocket |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected int port
protected int state
Constructor Detail |
public AbstractAdaptor()
Method Detail |
public java.lang.String getHost()
getHost
in interface Adaptor
public int getPort()
getPort
in interface Adaptor
public abstract java.lang.String getProtocol()
getProtocol
in interface Adaptor
public int getState()
getState
in interface Adaptor
public java.lang.String getStateInString()
getStateInString
in interface Adaptor
public void setPort(int port) throws java.lang.IllegalStateException
setPort
in interface Adaptor
java.lang.IllegalStateException
- if the adaptor is STARTING or STARTEDpublic boolean isActive()
isActive
in interface Adaptor
public boolean isSecure()
isSecure
in interface Adaptor
public abstract void enableAuthorisation(boolean flag) throws java.lang.UnsupportedOperationException
enableAuthorisation
in interface Adaptor
java.lang.UnsupportedOperationException
- when authorisation is not suppportedpublic abstract void enableAuthentication(boolean flag) throws java.lang.UnsupportedOperationException
enableAuthentication
in interface Adaptor
java.lang.UnsupportedOperationException
- when authentication is not supportedpublic void startService() throws java.lang.IllegalStateException, java.lang.Exception
startService
in interface Adaptor
java.lang.IllegalStateException
- when the adaptor is in STARTED or STARTING statepublic void stopService() throws java.lang.IllegalStateException
stopService
in interface Adaptor
java.lang.IllegalStateException
- when the adaptor is in STOPPED or STOPPING stateprotected abstract void instantiateAdaptor() throws java.lang.InstantiationException
protected abstract void bind()
protected abstract void unbind()
protected abstract void destroyAdaptor()
public java.lang.String getAdaptorVersion()
getAdaptorVersion
in interface Adaptor
public abstract ObjectName getAdaptorObjectName()
getAdaptorObjectName
in interface Adaptor
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback) throws java.lang.IllegalArgumentException
addNotificationListener
in interface NotificationBroadcaster
javax.management.NotificationBroadcaster
listener
- The listener object which will handles notifications
emitted by the registered MBean.filter
- The filter object. If not specified, no filtering will be
performed before handling notifications.handback
- The context to be sent to the listener when a
notification is emitted.java.lang.IllegalArgumentException
- Listener parameter is null.public MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo
in interface NotificationBroadcaster
javax.management.NotificationBroadcaster
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException
removeNotificationListener
in interface NotificationBroadcaster
javax.management.NotificationBroadcaster
listener
- The listener object which will handles notifications
emitted by the registered MBean.ListenerNotFoundException
- The listener is not registered in the MBean.public void changeState(int i)
public ObjectName preRegister(MBeanServer mbeanServer, ObjectName objectName) throws java.lang.Exception
preRegister
in interface MBeanRegistration
javax.management.MBeanRegistration
server
- The MBean server in which the MBean will be registered.name
- The object name of the MBean.java.lang.Exception
- This exception should be caught by the MBean server
and re-thrown as an MBeanRegistrationException
.public void postRegister(java.lang.Boolean registrationDone)
postRegister
in interface MBeanRegistration
javax.management.MBeanRegistration
registrationDone
- Indicates whether or not the MBean has been
successfully registered in the MBean server. The value
false means that the registration phase has failed.public void preDeregister() throws java.lang.Exception
preDeregister
in interface MBeanRegistration
javax.management.MBeanRegistration
java.lang.Exception
- This exception should be caught by the MBean server
and re-thrown as an MBeanRegistrationException
.public void postDeregister()
postDeregister
in interface MBeanRegistration
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |