org.jboss.resource.deployment
Class AdminObject

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.resource.deployment.AdminObject
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)

public class AdminObject
extends ServiceMBeanSupport (src)

An admin object deployment


Field Summary
protected  java.lang.String jndiName
          The jndi name
protected  java.util.Properties properties
          The properties
protected  ObjectName (src) rarName
          The resource adapter name
protected  java.lang.String type
          The admin object type
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
AdminObject()
           
 
Method Summary
protected  void bind(java.lang.Object object)
          Bind the object into jndi
protected  java.lang.Object createAdminObject(AdminObjectMetaData (src)  aomd)
          Create the admin object
 java.lang.String getJNDIName()
          Get the jndi name
 java.util.Properties getProperties()
          Get the properties
 ObjectName (src) getRARName()
          Get the rar name
 java.lang.String getType()
          Get the interface type
protected  AdminObjectMetaData (src) retrieveAdminObjectMetaData()
          Retrieve the admin object metadata
 void setJNDIName(java.lang.String jndiName)
          Set the jndi name
 void setProperties(java.util.Properties properties)
          Set the properties
 void setRARName(ObjectName (src)  rarName)
          Set the rar name
 void setType(java.lang.String type)
          Set the interface type
protected  void startService()
          Sub-classes should override this method to provide custum 'start' logic.
protected  void stopService()
          Sub-classes should override this method to provide custum 'stop' logic.
protected  void unbind()
          Unbind the object from jndi
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, createService, destroy, destroyService, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, stop
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rarName

protected ObjectName (src)  rarName
The resource adapter name


type

protected java.lang.String type
The admin object type


properties

protected java.util.Properties properties
The properties


jndiName

protected java.lang.String jndiName
The jndi name

Constructor Detail

AdminObject

public AdminObject()
Method Detail

getJNDIName

public java.lang.String getJNDIName()
Get the jndi name

Returns:
the jndi name

setJNDIName

public void setJNDIName(java.lang.String jndiName)
Set the jndi name

Parameters:
jndiName - the jndi name

getProperties

public java.util.Properties getProperties()
Get the properties

Returns:
the properties

setProperties

public void setProperties(java.util.Properties properties)
Set the properties

Parameters:
properties - the properties

getRARName

public ObjectName (src)  getRARName()
Get the rar name

Returns:
the rar name

setRARName

public void setRARName(ObjectName (src)  rarName)
Set the rar name

Parameters:
rarName - the rar name

getType

public java.lang.String getType()
Get the interface type

Returns:
the interface type

setType

public void setType(java.lang.String type)
Set the interface type

Parameters:
type - the interface type

startService

protected void startService()
                     throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'start' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
startService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'stop' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
stopService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

retrieveAdminObjectMetaData

protected AdminObjectMetaData (src)  retrieveAdminObjectMetaData()
                                                   throws DeploymentException (src) 
Retrieve the admin object metadata

Returns:
the admin object metadata
Throws:
DeploymentException (src) - for any error

createAdminObject

protected java.lang.Object createAdminObject(AdminObjectMetaData (src)  aomd)
                                      throws DeploymentException (src) 
Create the admin object

Parameters:
aomd - the admin object metadata
Returns:
the admin object
Throws:
DeploymentException (src) - for any error

bind

protected void bind(java.lang.Object object)
             throws java.lang.Exception
Bind the object into jndi

Parameters:
object - the object to bind
Throws:
java.lang.Exception - for any error

unbind

protected void unbind()
               throws java.lang.Exception
Unbind the object from jndi

Throws:
java.lang.Exception - for any error