wt.services
Class StandardManager

java.lang.Object
  wt.services.StandardManager

All Implemented Interfaces:

Manager, NetFactor, Serializable

Direct Known Subclasses:

CommonUfidService, CSMConstraintDBService, DefaultLogicRepositoryService, EPMStandardBaselineService, EPMStandardContextManager, EPMStandardDocumentManager, EPMStandardEventServiceManager, EPMStandardFamilyTableManager, EPMStandardStructureService, EPMStandardUploadManager, EPMStandardWorkspaceManager, IBAValueDBService, MultiObjIBAValueDBService, MultiObjIBAValueService, NavigationDBService, StandardAccessControlManager, StandardActionItemService, StandardAdministrativeDomainManager, StandardArchiveRestoreService, StandardAssociationService, StandardAttributeDefinitionService, StandardAuditService, StandardBaselineService, StandardBuildService, StandardBusinessEntityService, StandardCadAgentService, StandardCalendarService, StandardChangeService2, StandardClassificationService, StandardCollaborationService, StandardCollectionService, StandardCollectionsManager, StandardConfigService, StandardConfigurationService, StandardConflictFrameworkService, StandardContainerMoveService, StandardContainerTeamService, StandardContainerTemplateService, StandardContentCommandServerService, StandardContentService, StandardCounterPartService, StandardCSMConstraintService, StandardCsmIBAHolderListenerService, StandardCustomSearchManager, StandardDatabaseVersioningService, StandardDataSharingService, StandardDefinitionDescriptorFactory, StandardDefinitionDescriptorRemoteInterface, StandardDeleteManager, StandardDomainAdministratorService, StandardEffectivityService, StandardEffService, StandardEnterpriseService, StandardEPMSupportingDataService, StandardESIService, StandardExportService, StandardFastLoadService, StandardFdnWTContainerService, StandardFederationService, StandardFolderService, StandardFolderServiceSvr, StandardForumService, StandardFvService, StandardGenericTransportService, StandardGetAncestorsRemoteIfc, StandardGraphicsServerLoaderService, StandardHTMLLogService, StandardIBADefinitionService, StandardIBAValueService, StandardIdentityService, StandardImportService, StandardIndexManager, StandardIndexPolicyManager, StandardInitRuleEvalService, StandardInterSvrComService, StandardIXBService, StandardLifeCycleService, StandardLineNumberService, StandardLoadService, StandardLockService, StandardLogService, StandardManagerService, StandardManifestService, StandardMasterService, StandardMaturityService, StandardMeetingService, StandardMsProjectService, StandardNavigationService, StandardNmActionItemService, StandardNmActionService, StandardNmBookmarkService, StandardNmDocumentService, StandardNmFolderService, StandardNmForumService, StandardNmGroupService, StandardNmInteropService, StandardNmIxbService, StandardNmLibraryService, StandardNmLifeCycleService, StandardNmMeetingService, StandardNmMsProjectService, StandardNmNotebookFolderService, StandardNmNotebookService, StandardNmObjectService, StandardNmOrganizationService, StandardNmPartService, StandardNmPostingService, StandardNmProductService, StandardNmProjectService, StandardNmProjMgmtService, StandardNmReportService, StandardNmRoleService, StandardNmRuleService, StandardNmSubscriptionService, StandardNmTemplatesService, StandardNmTopicService, StandardNmTypeService, StandardNmUserService, StandardNmWorkflowService, StandardNmWorkItemService, StandardNotebookService, StandardNotificationManager, StandardObjectGraphService, StandardObjReferenceCacheService, StandardOccurrenceService, StandardOrganizationServicesManager, StandardOwnershipService, StandardPartDocService, StandardPDMLinkService, StandardPersistenceManager, StandardPreferenceService, StandardProfilerService, StandardProjAdminService, StandardProjDefinerService, StandardProjectService, StandardProjExecService, StandardProjMgmtService, StandardProjMonitorService, StandardProjResourceService, StandardPublishService, StandardPurgeService, StandardQueryService, StandardQueueService, StandardRankingService, StandardReceiverService, StandardRecentlyVisitedService, StandardReplicaService, StandardReplicationRecvService, StandardRepresentationService, StandardRequiredDataService, StandardRequirementService, StandardRoutingService, StandardRuleService, StandardSandboxService, StandardSaveAsService, StandardSchedulingService, StandardSenderService, StandardSeriesService, StandardSessionIterationService, StandardSessionManager, StandardShippingService, StandardStructService, StandardTaskManager, StandardTeamService, StandardTransferPolicyService, StandardTransferService, StandardTypeAdminService, StandardTypedUtilityService, StandardTypeIdentifierUtilityService, StandardUnitsService, StandardUploadToCacheService, StandardVersionControlService, StandardViewMarkUpService, StandardViewService, StandardWfDefinerService, StandardWfEngineService, StandardWorkflowService, StandardWorkInProgressService, StandardWTContainerService, StandardWTDocumentService, StandardWTPartService, StandardWTUnitService, TypeManagementConstraintDBService, WTTypeManagementDBService

public class StandardManager

extends Object

implements Manager, Serializable

StandardManager is the base class for NetFactor sevices and managers..

Use the newStandardManager static factory method(s), not the StandardManager constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private ManagerService	managerService
private int	managerStatus
private String	name
private static String	RESOURCE
private String	startupType

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardManager()

Method Summary

void	emergencyShutdown() Manager emergency shutdown operation.
protected void	emergencyShutdownComplete() Method for dispatching a Manager startup event to all listeners.
protected void	emergencyShuttingDown() Method for dispatching a Manager emergency shutdown event to all listeners.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
ManagerService	getManagerService() Gets the value of the attribute: managerService; Service which manages this manager Supported API: true
int	getManagerStatus() Gets the value of the attribute: managerStatus; Manager status set to Manager.STATUS_SHUTDOWN, Manager.STATUS_STARTED, ... Supported API: true
String	getName() Gets the value of the attribute: name; Manager name Supported API: true
String	getStartupType() Gets the value of the attribute: startupType; Manager startup type.
protected void	init(String managerName, String startupType) Supported API: false
protected void	initialize() Supported API: false
protected void	initialize(String name, String startupType) Supports initialization, following construction of an instance.
boolean	isStarted() Determin if the manager is started Answers true if status is STATUS_STARTED or STATUS_STATUS_ERRORS.
static StandardManager	newStandardManager() Supported API: false
static StandardManager	newStandardManager(String name, String startupType) Supported API: false
protected void	performEmergencyShutdownProcess() Dummy method to be overridden by subclasses.
protected void	performShutdownProcess() Dummy method to be overridden by subclasses.
protected void	performStartupProcess() Dummy method to be overridden by subclasses.
void	registerEvents(ManagerService managerService) Register events with the passed ManagerService.
void	setManagerService(ManagerService managerService) Supported API: false
void	shutdown() Manager shutdown operation.
protected void	shutdownFailure() Method for dispatching a Manager shutdown failure event to all listeners.
protected void	shutdownSuccess() Method for dispatching a Manager startup event to all listeners.
protected void	shuttingDown() Method for dispatching a Manager startup event to all listeners.
protected void	started() Method for dispatching a Manager started event to all listeners.
protected void	startedErrors() Method for dispatching a Manager startup event to all listeners.
protected void	startingUp() Method for dispatching a Manager starting up event to all listeners.
void	startup() Template routine for starting up a service.
protected void	startupFailure() Method for dispatching a Manager startup event to all listeners.
String	toString() Returns the conceptual (modeled) name for the class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

startupType

private String startupType

managerStatus

private int managerStatus

managerService

private ManagerService managerService

Constructor Detail

StandardManager

public StandardManager()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getName

public String getName()

Gets the value of the attribute: name; Manager name

Supported API: true

Specified by:

getName in interface Manager

Returns:

String

getStartupType

public String getStartupType()

Gets the value of the attribute: startupType; Manager startup type.

Must be either Manager.STARTUP_AUTOMATIC or manager.STARTUP_MANUAL

Supported API: true

Specified by:

getStartupType in interface Manager

Returns:

String

See Also:

wt.services.Manager.STARTUP_AUTOMATIC

getManagerStatus

public int getManagerStatus()

Gets the value of the attribute: managerStatus; Manager status set to Manager.STATUS_SHUTDOWN, Manager.STATUS_STARTED, ...


Supported API: true

Specified by:

getManagerStatus in interface Manager

Returns:

int

See Also:

Manager.STATUS_SHUTDOWN

getManagerService

public ManagerService getManagerService()

Gets the value of the attribute: managerService; Service which manages this manager

Supported API: true

Specified by:

getManagerService in interface Manager

Returns:

ManagerService

newStandardManager

public static StandardManager newStandardManager()
                                          throws WTException

Supported API: false

Returns:

StandardManager

Throws:

WTException

newStandardManager

public static StandardManager newStandardManager(String name,
                                                 String startupType)
                                          throws WTException

Supported API: false

Parameters:

name -

startupType -

Returns:

StandardManager

Throws:

WTException

initialize

protected void initialize(String name,
                          String startupType)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

name -

startupType -

Throws:

WTException

init

protected void init(String managerName,
                    String startupType)

Supported API: false

Parameters:

managerName -

startupType -

initialize

protected void initialize()
                   throws WTException

Supported API: false

Throws:

WTException

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException

Dummy method to be overridden by subclasses. Subclasses should override this method and provide startup processing.

Supported API: false

Throws:

ManagerException

performShutdownProcess

protected void performShutdownProcess()
                               throws ManagerException

Dummy method to be overridden by subclasses. Subclasses should override this method and provide shutdown processing.

Supported API: false

Throws:

ManagerException

performEmergencyShutdownProcess

protected void performEmergencyShutdownProcess()

Dummy method to be overridden by subclasses. Subclasses should override this method and provide shutdown processing.

Supported API: false

startingUp

protected void startingUp()
                   throws ManagerException

Method for dispatching a Manager starting up event to all listeners. Typical subclasses will not override this method. Listeners may object to startup by throwing a ManagerException.

Supported API: false

Throws:

ManagerException

started

protected void started()

Method for dispatching a Manager started event to all listeners. Typical subclasses will not override this method. Listeners may not object to this event.

Supported API: false

startedErrors

protected void startedErrors()

Method for dispatching a Manager startup event to all listeners. Typical subclasses will not override this method. Listeners may not object to this event.

Supported API: false

startupFailure

protected void startupFailure()

Method for dispatching a Manager startup event to all listeners. Typical subclasses will not override this method. Listeners may not object to this event.

Supported API: false

shuttingDown

protected void shuttingDown()
                     throws ManagerException

Method for dispatching a Manager startup event to all listeners. Typical subclasses will not override this method. Listeners may object by throwing a ManagerException.

Supported API: false

Throws:

ManagerException

shutdownSuccess

protected void shutdownSuccess()

Method for dispatching a Manager startup event to all listeners. Typical subclasses will not overrides this method. Listeners may not object to this event.

Supported API: false

shutdownFailure

protected void shutdownFailure()

Method for dispatching a Manager shutdown failure event to all listeners. Typical subclasses will not override this method. Listeners may not object] to this event.

Supported API: false

emergencyShuttingDown

protected void emergencyShuttingDown()

Method for dispatching a Manager emergency shutdown event to all listeners. Typical subclasses will not override this method. Listeners may not object to this event.

Supported API: false

emergencyShutdownComplete

protected void emergencyShutdownComplete()

Method for dispatching a Manager startup event to all listeners. Typical subclasses will not override this method. Listeners may not object to this event.

Supported API: false

startup

public void startup()
             throws ManagerException

Template routine for starting up a service. This method calls the startingUp method which handles generating and synchronously dispatching an event to all listeners. Listeners may object to the startup by throwing a ManagerException.

This is a template method and should generally not be overridden. Typically the method performStartupProcess sshould be overridden by subclasses.

Manager startup operation. Generally this operation changes the manager status from:

STATUS_SHUTDOWN -> STATUS_STARTING -> STATUS_STARTED.

Supported API: false

Specified by:

startup in interface Manager

Throws:

ManagerException

shutdown

public void shutdown()
              throws ManagerException

Manager shutdown operation.

Generally this operation changes the manager status from:

STATUS_STARTED -> STATUS_SHUTTING_DOWN -> STATUS_SHUTDOWN

Template routine for shutting down a service. This method calls the shuttingDown method which handles generating and synchronously dispatching an event to all listeners. Listeners may object to the shutdown by throwing a ManagerException.

This is a template method and should generally not be overridden. Typically the method performShutdownProcess should be overridden by subclasses.

Supported API: false

Specified by:

shutdown in interface Manager

Throws:

ManagerException

emergencyShutdown

public void emergencyShutdown()
                       throws ManagerException

Manager emergency shutdown operation. This request can't be refused.

Template routine for emergency shutdown of a manager. This method calls the emergencyShuttingDown method which handles generating and synchronously dispatching an event to all listeners. Listeners may not object to this operation.

This is a template method and should generally not be overridden. Typically the method performEmergencyShutdownProcess should be overridden by subclasses.

Supported API: false

Specified by:

emergencyShutdown in interface Manager

Throws:

ManagerException

isStarted

public boolean isStarted()

Determin if the manager is started Answers true if status is STATUS_STARTED or STATUS_STATUS_ERRORS.

Supported API: false

Specified by:

isStarted in interface Manager

Returns:

boolean

registerEvents

public void registerEvents(ManagerService managerService)

Register events with the passed ManagerService. The default method does nothing, subclasses should provide an overriding implementation.

Supported API: false

Specified by:

registerEvents in interface Manager

Parameters:

managerService - the ManagerService with which to register events.

setManagerService

public void setManagerService(ManagerService managerService)

Supported API: false

Specified by:

setManagerService in interface Manager

Parameters:

managerService -