XMOJO 5 API Docs

com.adventnet.adaptors
Class AbstractAdaptor

java.lang.Object
  |
  +--com.adventnet.adaptors.AbstractAdaptor
All Implemented Interfaces:
Adaptor, MBeanRegistration, NotificationBroadcaster, java.io.Serializable
Direct Known Subclasses:
HtmlAdaptor, RMIAdaptor

public abstract class AbstractAdaptor
extends java.lang.Object
implements Adaptor, MBeanRegistration, NotificationBroadcaster, java.io.Serializable

This abstract class abstracts the common behaviour of all Adaptors. All Protocol Adaptors must extend this class .

Since:
Adaptor Framework Version 2.0
Author:
Deepth Dinesan
See Also:
com.adventnet.adaptor.Adaptor, com.adventnet.adaptor.Protocol, Serialized Form

Field 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

port

protected int port

state

protected int state
Constructor Detail

AbstractAdaptor

public AbstractAdaptor()
Method Detail

getHost

public java.lang.String getHost()
This method returns the host on which the adaptor resides
Specified by:
getHost in interface Adaptor

getPort

public int getPort()
This method returns the port on which the adaptor listens
Specified by:
getPort in interface Adaptor

getProtocol

public abstract java.lang.String getProtocol()
This abstract method returns the Protocol on which the adaptor is listening
Specified by:
getProtocol in interface Adaptor

getState

public int getState()
This method returns the state of the adaptor
Specified by:
getState in interface Adaptor

getStateInString

public java.lang.String getStateInString()
This method returns the state of the adaptor in string format
Specified by:
getStateInString in interface Adaptor

setPort

public void setPort(int port)
             throws java.lang.IllegalStateException
This method sets the port on which this adaptor is listening
Specified by:
setPort in interface Adaptor
Throws:
java.lang.IllegalStateException - if the adaptor is STARTING or STARTED

isActive

public boolean isActive()
This method returns true if the Adaptor is in STARTING or STARTED state
Specified by:
isActive in interface Adaptor

isSecure

public boolean isSecure()
Default returns false . Needs to overriden by the Adaptor implementation
Specified by:
isSecure in interface Adaptor

enableAuthorisation

public abstract void enableAuthorisation(boolean flag)
                                  throws java.lang.UnsupportedOperationException
This abstract method needs to be implemented by the Adaptor for providing Authorisation
Specified by:
enableAuthorisation in interface Adaptor
Throws:
java.lang.UnsupportedOperationException - when authorisation is not suppported

enableAuthentication

public abstract void enableAuthentication(boolean flag)
                                   throws java.lang.UnsupportedOperationException
This abstract method needs to be implemented by the Adaptor for providing Authentication
Specified by:
enableAuthentication in interface Adaptor
Throws:
java.lang.UnsupportedOperationException - when authentication is not supported

startService

public void startService()
                  throws java.lang.IllegalStateException,
                         java.lang.Exception
This method starts the Adaptor service
Specified by:
startService in interface Adaptor
Throws:
java.lang.IllegalStateException - when the adaptor is in STARTED or STARTING state

stopService

public void stopService()
                 throws java.lang.IllegalStateException
This method stops the Adaptor
Specified by:
stopService in interface Adaptor
Throws:
java.lang.IllegalStateException - when the adaptor is in STOPPED or STOPPING state

instantiateAdaptor

protected abstract void instantiateAdaptor()
                                    throws java.lang.InstantiationException
Must be implemented by the adaptor and should be used to instantiate itsefl

bind

protected abstract void bind()
Must be used to bind to a naming service or to bind to a ServerSocket

unbind

protected abstract void unbind()
Must be used to unbind from a naming service or to relese a ServerSocket

destroyAdaptor

protected abstract void destroyAdaptor()
Kills the adaptor and releases all its resources

getAdaptorVersion

public java.lang.String getAdaptorVersion()
Returns the adaptor version implemented by this Adaptor
Specified by:
getAdaptorVersion in interface Adaptor

getAdaptorObjectName

public abstract ObjectName getAdaptorObjectName()
Returns the adaptor object name
Specified by:
getAdaptorObjectName in interface Adaptor

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                                    NotificationFilter filter,
                                    java.lang.Object handback)
                             throws java.lang.IllegalArgumentException
This method can be used to Add a Notification Listener for this Adaptor
Specified by:
addNotificationListener in interface NotificationBroadcaster
Following copied from interface: javax.management.NotificationBroadcaster
Parameters:
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.
Throws:
java.lang.IllegalArgumentException - Listener parameter is null.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()
This method returns the NotificationInfo
Specified by:
getNotificationInfo in interface NotificationBroadcaster
Following copied from interface: javax.management.NotificationBroadcaster
Returns:
This returns a array of MBeanNotificationInfo which contains the notification information

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException
This method removes the Notification Listeners
Specified by:
removeNotificationListener in interface NotificationBroadcaster
Following copied from interface: javax.management.NotificationBroadcaster
Parameters:
listener - The listener object which will handles notifications emitted by the registered MBean.
Throws:
ListenerNotFoundException - The listener is not registered in the MBean.

changeState

public void changeState(int i)
This method changes the state of the adaptor

preRegister

public ObjectName preRegister(MBeanServer mbeanServer,
                              ObjectName objectName)
                       throws java.lang.Exception
This method must be overriden by the Adaptor if the Adaptor wants to perform any Pre registration tasks
Specified by:
preRegister in interface MBeanRegistration
Following copied from interface: javax.management.MBeanRegistration
Parameters:
server - The MBean server in which the MBean will be registered.
name - The object name of the MBean.
Returns:
The name of the MBean registered.
Throws:
java.lang.Exception - This exception should be caught by the MBean server and re-thrown as an MBeanRegistrationException.

postRegister

public void postRegister(java.lang.Boolean registrationDone)
This method must be overridden by the Adaptor if the Adaptor wants to perform any Post Registration tasks
Specified by:
postRegister in interface MBeanRegistration
Following copied from interface: javax.management.MBeanRegistration
Parameters:
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.

preDeregister

public void preDeregister()
                   throws java.lang.Exception
This method must be overridden by the Adaptor if it wants to perform any Pre Deregistration tasks
Specified by:
preDeregister in interface MBeanRegistration
Following copied from interface: javax.management.MBeanRegistration
Throws:
java.lang.Exception - This exception should be caught by the MBean server and re-thrown as an MBeanRegistrationException.

postDeregister

public void postDeregister()
This method must be implemented by the Adaptor if it wants to perform any Post Deregistration tasks
Specified by:
postDeregister in interface MBeanRegistration

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.