org.jboss.system
Class ServiceMBeanSupport

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      org.jboss.system.ServiceMBeanSupport

All Implemented Interfaces:

MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)

Direct Known Subclasses:

AbstractDeploymentScanner (src) , AbstractInstancePool (src) , AbstractMailTransportService (src) , AbstractMonitor (src) , AbstractScheduler (src) , AbstractStateManager (src) , Adaptor (src) , AdminObject (src) , AOPTester (src) , AttributePersistenceService (src) , AxisService (src) , BarrierController.Barrier (src) , BaseConnectionManager2 (src) , BrokenDeployer (src) , CachedConnectionManager (src) , CacheListener (src) , CacheTester (src) , ChildProcessService (src) , ClasspathExtension (src) , ClasspathTest (src) , ClazzTest (src) , ClientUserTransactionService (src) , ClusteredHTTPSessionService (src) , ClusterPartition (src) , CMPFilePersistenceManager (src) , CMPInMemoryPersistenceManager (src) , ConcurrentLoader (src) , ConnectionFactoryBindingService (src) , Container (src) , ContainerRelection (src) , CorbaNamingService (src) , CorbaORBService (src) , CorbaTransactionService (src) , CounterService (src) , DatabasePersistencePolicy (src) , DataSourceMetaData (src) , DeploymentCache (src) , DeploymentFileRepository (src) , DerbyDatabase (src) , DestinationMBeanSupport (src) , DetachedHANamingService (src) , DLQHandler (src) , DynamicLoginConfig (src) , EARDeployment (src) , EjbModule (src) , EJBTimerServiceImpl (src) , EntityLockMonitor (src) , ExitOnShutdown (src) , ExternalClass (src) , ExternalContext (src) , FileDeploymentStore (src) , FixedDelayRetryPolicy (src) , HAManagementService (src) , HAService (src) , HAServiceMBeanSupport (src) , HASessionStateService (src) , Hibernate (src) , HiLoKeyGeneratorFactory (src) , HttpInvoker (src) , HttpProxyFactory (src) , HttpsClient (src) , HypersonicDatabase (src) , IIOPInvoker (src) , InterceptorMBeanSupport (src) , InterruptTest (src) , InvalidationManager (src) , Invoker (src) , InvokerAdaptorService (src) , J2EEManagedObject (src) , JaasSecurityManager (src) , JaasSecurityManagerService (src) , JBossAlertListener (src) , JBossLocalXAExceptionFormatter (src) , JBossManagedConnectionPool (src) , JBossMessageEndpointFactory (src) , JBossMonitor (src) , JBossWorkManager (src) , JCEProviderService (src) , JGCacheInvalidationBridge (src) , JMSCacheInvalidationBridge (src) , JMSContainerInvoker (src) , JMSProviderLoader (src) , JNDIView (src) , JRMPProxyFactory (src) , JUDDIService (src) , LinkRefPairService (src) , ListenerServiceMBeanSupport (src) , LoadbalancerService (src) , LocalInvoker (src) , Log4jService (src) , Log4jSocketServer (src) , MailService (src) , MainDeployer (src) , ManagedMediaFormatRegistry (src) , MediaFactory (src) , MediaPluginRegistry (src) , MediaPublisherFactory (src) , MediaRegistry (src) , MediaTranscoderRegistry (src) , MemoryMonitor (src) , MessageCache (src) , MetaDataLibrary (src) , MissingClassTest (src) , NamingAlias (src) , NamingService (src) , NoInternalJBoss (src) , NoopService (src) , NotificationProducerService (src) , ObservableTester (src) , OldStateManager (src) , OracleXAExceptionFormatter (src) , PartitionedTableCache (src) , PersistenceManager (src) , PersistenceManager (src) , PersistenceManager (src) , PersistentServiceExample (src) , PingJndi (src) , PluginManager (src) , PooledInvoker (src) , PropertiesVerifierStore (src) , PropertyEditorManagerService (src) , ProxyTests (src) , RARDeployment (src) , RemotingTester (src) , ReportGenerator (src) , ResourceTest (src) , ResourceTsts (src) , SchedulableMBeanExample (src) , ScheduleManager (src) , Scheduler (src) , SecuredService (src) , SecurityConfig (src) , SecurityConfig (src) , SecurityTester (src) , SelfListenerService (src) , ServerILJMXService (src) , ServerSessionPoolLoader (src) , ServiceClientDeployer (src) , ServiceDeployer (src) , ServiceDynamicMBeanSupport (src) , SimpleBeanTester (src) , SQLExceptionProcessor (src) , SRPCacheTest (src) , SRPService (src) , SRPVerifierStoreService (src) , Starter (src) , StatefulHASessionPersistenceManager (src) , StatefulSessionFilePersistenceManager (src) , StatisticsCollector (src) , SubDeployerSupport (src) , SystemAuthenticator (src) , SystemPropertiesService (src) , TableCache (src) , Target (src) , Test (src) , Test (src) , TestClass (src) , TestDeployer (src) , TestDeployerA (src) , TestDeployerB (src) , TestDeployerC (src) , TestDeployerD (src) , TestDeployerE (src) , TestMBClassLoader (src) , TestMessageDrivenManagement (src) , TestService (src) , TMTest (src) , TopologyMonitorService (src) , TransactionManagerService (src) , TrapdService (src) , TreeCache (src) , TreeCacheView (src) , TxLockTester (src) , TxTester (src) , UUIDKeyGeneratorFactoryService (src) , VersionedObjectTester (src) , WebLogicConvertor (src) , WebModule (src) , WebService (src) , XMLLoginConfig (src)

public class ServiceMBeanSupport

extends JBossNotificationBroadcasterSupport (src)

implements ServiceMBean (src) , MBeanRegistration (src)

An abstract base class JBoss services can subclass to implement a service that conforms to the ServiceMBean interface. Subclasses must override getName() method and should override startService(), and stopService() as approriate.

See Also:

ServiceMBean (src)

SERVICE_CONTROLLER_SIG

public static final java.lang.String[] SERVICE_CONTROLLER_SIG

The signature for service controller operations

log

protected Logger (src)  log

The instance logger for the service. Not using a class logger because we want to dynamically obtain the logger name from concreate sub-classes.

server

protected MBeanServer (src)  server

The MBeanServer which we have been register with.

serviceName

protected ObjectName (src)  serviceName

The object name which we are registsred under.

ServiceMBeanSupport

public ServiceMBeanSupport()

Construct a ServiceMBeanSupport.

Sets up logging.

ServiceMBeanSupport

public ServiceMBeanSupport(java.lang.Class type)

Construct a ServiceMBeanSupport.

Sets up logging.

Parameters:

type - The class type to determine category name from.

ServiceMBeanSupport

public ServiceMBeanSupport(java.lang.String category)

Construct a ServiceMBeanSupport.

Sets up logging.

Parameters:

category - The logger category name.

ServiceMBeanSupport

public ServiceMBeanSupport(Logger (src)  log)

Construct a ServiceMBeanSupport.

Parameters:

log - The logger to use.

getName

public java.lang.String getName()

Use the short class name as the default for the service name.

Specified by:

getName in interface ServiceMBean (src)

getServiceName

public ObjectName (src)  getServiceName()

getServer

public MBeanServer (src)  getServer()

getState

public int getState()

Specified by:

getState in interface ServiceMBean (src)

getStateString

public java.lang.String getStateString()

Specified by:

getStateString in interface ServiceMBean (src)

getLog

public Logger (src)  getLog()

create

public void create()
            throws java.lang.Exception

Description copied from interface: Service (src)

create the service, do expensive operations etc

Specified by:

create in interface Service (src)

Throws:

java.lang.Exception

start

public void start()
           throws java.lang.Exception

Description copied from interface: Service (src)

start the service, create is already called

Specified by:

start in interface Service (src)

Throws:

java.lang.Exception

stop

public void stop()

Description copied from interface: Service (src)

stop the service

Specified by:

stop in interface Service (src)

destroy

public void destroy()

Description copied from interface: Service (src)

destroy the service, tear down

Specified by:

destroy in interface Service (src)

jbossInternalDescription

protected java.lang.String jbossInternalDescription()

jbossInternalLifecycle

public void jbossInternalLifecycle(java.lang.String method)
                            throws java.lang.Exception

Description copied from interface: ServiceMBean (src)

Detyped lifecycle invocation

Specified by:

jbossInternalLifecycle in interface ServiceMBean (src)

Throws:

java.lang.Exception

jbossInternalCreate

protected void jbossInternalCreate()
                            throws java.lang.Exception

Throws:

java.lang.Exception

jbossInternalStart

public void jbossInternalStart()
                        throws java.lang.Exception

Throws:

java.lang.Exception

jbossInternalStop

public void jbossInternalStop()

jbossInternalDestroy

public void jbossInternalDestroy()

preRegister

public ObjectName (src)  preRegister(MBeanServer (src)  server,
                              ObjectName (src)  name)
                       throws java.lang.Exception

Callback method of MBeanRegistration (src) before the MBean is registered at the JMX Agent.

Attention: Always call this method when you overwrite it in a subclass because it saves the Object Name of the MBean.

Specified by:

preRegister in interface MBeanRegistration (src)

Parameters:

server - Reference to the JMX Agent this MBean is registered on

name - Name specified by the creator of the MBean. Note that you can overwrite it when the given ObjectName is null otherwise the change is discarded (maybe a bug in JMX-RI).

Returns:

the actual ObjectName to register this MBean with.

Throws:

java.lang.Exception - for any error, the MBean is not registered.

postRegister

public void postRegister(java.lang.Boolean registrationDone)

Description copied from interface: MBeanRegistration (src)

This method is called by the MBeanServer after registration takes place or when registration fails.

Specified by:

postRegister in interface MBeanRegistration (src)

Parameters:

registrationDone - the MBeanServer passes true when the MBean was registered, false otherwise.

preDeregister

public void preDeregister()
                   throws java.lang.Exception

Description copied from interface: MBeanRegistration (src)

This method is called by the MBeanServer before deregistration takes place.

The MBean can throw an exception, this will stop the deregistration. The exception is forwarded to the invoker wrapped in an MBeanRegistrationException.

Specified by:

preDeregister in interface MBeanRegistration (src)

Throws:

java.lang.Exception

postDeregister

public void postDeregister()

Description copied from interface: MBeanRegistration (src)

This method is called by the MBeanServer after deregistration takes place.

Specified by:

postDeregister in interface MBeanRegistration (src)

getNextNotificationSequenceNumber

protected long getNextNotificationSequenceNumber()

The getNextNotificationSequenceNumber method returns the next sequence number for use in notifications.

Returns:

a long value

getObjectName

protected ObjectName (src)  getObjectName(MBeanServer (src)  server,
                                   ObjectName (src)  name)
                            throws MalformedObjectNameException (src) 

Sub-classes should override this method if they only need to set their object name during MBean pre-registration.

Throws:

MalformedObjectNameException (src)

createService

protected void createService()
                      throws java.lang.Exception

Sub-classes should override this method to provide custum 'create' 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.

Throws:

java.lang.Exception

startService

protected void startService()
                     throws java.lang.Exception

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.

Throws:

java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception

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.

Throws:

java.lang.Exception

destroyService

protected void destroyService()
                       throws java.lang.Exception

Sub-classes should override this method to provide custum 'destroy' 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.

Throws:

java.lang.Exception