psdi.server

Interface Service

All Known Implementing Classes:

ActionsCfgService, ActualCIService, AMCrewService, AppService, AppSetupService, ApptBookService, AssetCatalogService, AssetService, BBService, BIMService, BudgetService, BulletinBoardService, BusMemberService, CalendarService, CdmCiTypeService, CIService, CollectionService, CompanyService, CompMasterService, ConfigureService, ContractService, CraftService, CurrencyService, CustomService, DeployedAssetService, DigitalTwinService, DJPService, DMService, DoclinkService, DPAMAdapterService, DPAMManufacturerService, DPAMOSYSService, DPAMProcessorService, DPAMSoftwareService, DPAMSWSuiteService, DPAMSWUsageService, DpldNDAssetService, DpldNPAssetService, EntMicService, EscalationService, EventResponseService, FAConfigService, FailureService, FeatureService, FinancialService, FusionService, IMProfileService, InbxConfigService, InsightService, InspectionService, IntegrationService, InventoryService, InvoiceService, InvUseService, IoTConnectionService, IoTFService, ItemService, JEAppService, JobPlanService, KBService, KPIGConfigService, KPILConfigService, KPIService, LaborService, LabTransService, LocationService, LoggingService, MapManagerService, MapSketchService, MaxLicMonitorService, MaxRecordLockService, MaxVarService, MeasurementService, MeterService, MfMailService, MicService, MRService, OmpService, OptimizationService, ParserService, PersonGroupService, PersonService, PlusCAssetTemplateService, PlusCDSService, PlusCJPService, PMService, POService, PRService, PushNotificationService, QualService, ReconCompRuleService, ReconLinkRuleService, ReconLinkService, ReconResultService, ReconTaskFilterService, ReconTaskService, RelationService, ReorderService, ReportAdminService, ReportListCfgService, ReportService, RestService, RFQService, RouteService, RSConfigService, SafetyService, SCConfigService, ScriptService, SecurityService, ServiceAddressService, ServiceContractService, SetsService, SfwlicviewService, SignatureService, SiteService, SKDAppService, SKDOverrideAvailService, SKDTooltipService, SLAService, SLRouteService, SoftwareCatalogService, STTService, SystemService, TicketService, ToolService, WeatherAPIService, WeatherCfgService, WorkFlowService, WOService

public interface Service

Abstracts the "life-cycle" of both System and Application Services. 1) They get constructed, 2) configure() is called 3) init() is called. At which point they're ready to service their requests, specific to the service they're providing. 4) destroy() is called as the system is shutting down. This is when any system resources should be freed. 5) They are finalized. The two step process of configuration and initialization allows them to find each other via the ServiceCoordinator class.

MXServer configures all services and then initializes them. Both "system" Services, e.g. the DataDictionary and Application Services implement this interface. The goal is to have a standard interface for the MXServer to start and stop it's component "Services".

Version:

%I%, %G%

Author:

John Langley

See Also:

MXServer, ServiceCoordinator

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Properties configData) Configuration information is presented in a Property object.
void	destroy() Release system resources.
java.lang.String	getName() Get's the name of the Service.
java.lang.String	getURL()
void	init() Initialization should take place.
boolean	isAppService()
boolean	isSingletonService() Is used to setup singleton services, i.e.
void	setURL(java.lang.String url)

Method Detail

configure

void configure(java.util.Properties configData)

Configuration information is presented in a Property object.

init

void init()
   throws java.lang.Exception

Initialization should take place. This where long duration tasks and those that throw exceptions should take place, e.g. establishing network connections.

Throws:

java.lang.Exception

destroy

void destroy()

Release system resources. The object should release all system resources. This will be called only once and is called to prepare the object for finalization.

getName

java.lang.String getName()

Get's the name of the Service.

getURL

java.lang.String getURL()

isAppService

boolean isAppService()

setURL

void setURL(java.lang.String url)

isSingletonService

boolean isSingletonService()

Is used to setup singleton services, i.e. this service is to be started on only one server. Method needs to be overridden if the service needs to be singleton.