GenericService (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

AbandonedOrderEventListener, AbandonedOrderTools, AbandonmentActionConfiguration, AbstractCache, AbstractCommerceIdentifierRestSubresource, AbstractInventoryManagerImpl, AbstractItemLookupRestResource, AbstractOrderRestResource, AbstractSequentialIdGenerator, AbstractShippingMethodRestResource, AccessRightAccessController, ActorChainService, ADCClientRequestData, ADCConfiguration, ADCEventMonitor, ADCPipelineProcessor, ADCRequestData, AddressRestSubresource, AddressValidatorImpl, AgentAuditRecorder, AgentMessageSource, AgentMessagingTools, AgentSessionEndListener, AgentTools, AllAccessController, AssemblerApplicationConfiguration, AssemblerTools, BaseCommand, BaseCommandHandler, BatchEmailListener, BusinessProcessManager, BusinessProcessServices, C2CConfiguration, C2CSessionDataPropertyManager, C2CTokenGenerator, CachedCollectionFilter, CanPurgeProcessor, CatalogCompletionService, CatalogMigration, CatalogServices, CatalogTools, ChunkedTimeInterval, ClaimableManager, ClaimableTools, ClientLockManager, CloneEditHandler, CloneEditManager, ClosenessQualifierEvaluator, ClosenessQualifierRestSubresource, CollectorPropertyService, CommerceC2CSessionDataPropertyManager, CommerceItemManager, CommerceItemShippingInfoTools, CompareByProperties, ComparisonList, CompositeXMLHandlerFactory, Configuration, Configuration, ContentItemToRendererPathImpl, atg.repository.content.ContentRepositoryService, ContextRootSwappingService, ContextValueRetriever, CookieManager, CoordinateManager, CopyInvoiceRequestProperties, CortexIntrospectorService, CostCenterContainerService, CostCenterManager, CreditCardRestSubresource, CreditCardTools, CurrencyRestResource, CurrentDate, CurrentUserRestResource, CustomCatalogVariantProducer, atg.search.adapter.customization.CustomizationDataAdapterImpl, DataCollectorService, DataContentHandlerRegistry, DataSource, DBCopier, DefaultActionPathProvider, DefaultMetaPropertyValueFormatter, DefaultSiteContextRuleFilter, DeleteMissingIndexingSynchronization, DeploymentServer, DimensionRootNodeSynchronization, DimensionValueCacheTools, DiscountCalculatorService, DispatchLogger, DisplayLogger, DistributorSender, DOMWriterService, DummyCreditCardProcessor, DummyTaxProcessor, DynamicContentGroup, DynamicContentTargeter, DynamicSitemapGenerator, atg.service.email.examiner.EmailExaminerImpl, EmailLogger, EmptyFormHandler, EventQueue, atg.endeca.index.ExporterHelperIndexingSynchronization, ExpressionParser, ExternalRepositoryUpdate, FacetManager, FakeXADataSource, FileXMLHandlerFactory, FilterActionConfiguration, FilteringManager, FormattingLogger, GearMessagePublisher, GenerateInvoiceMessage, GenericAccountInitializer, GenericContext, GenericConverter, GenericDataListenerService, GenericDimensionService, GenericHandler, GenericReference, GenericRestProcessor, GenericSecuredRepository, GenericSecuredResourceService, GenericVariableRankingProperty, GeoLocatorService, GetService, GiftCertificateProcessorImpl, GiftlistManager, GiftlistTools, GroupAccessController, GWPManager, HandlingInstructionManager, HardgoodShipper, HypermediaJSONMessageBodyReader, HypermediaJSONMessageBodyWriter, IndexingPropertyProvider, InfoGeneratorService, InitialService, InMemoryJobQueue, InStorePaymentProcessorImpl, IntegrationRepositoryTools, InventoryServices, InvoiceManager, InvoiceRequestProcessorImpl, InvoiceTools, iPlanetSSHAPasswordHasher, ItemListPriceCalculator, ItemPriceCalculator, ItemPriceCalculator, ItemSalesPriceCalculator, ItemSalesTieredPriceCalculator, ItemTieredPriceCalculator, JapaneseConverter, JAXRSApplicationRegistry, JAXRSCachePostMatchRequestFilter, JAXRSCacheResponseFilter, JAXRSCacheWriterInterceptor, JAXRSJSONMessageBodyWriter, JournalingFileSystemService, JTSQLTableLogger, LinkUtils, LoaderImpl, LocalSynchronizationInvokerService, LogPromotionInfoConfiguration, atg.nucleus.logging.LogRedirectingGenericService, MappingManager, MarkerConfiguration, MarkerMessageSource, MembershipContext.MembershipContextService, MemorySampler, MessageContentProcessor, MetaPropertiesHelper, MetaPropertiesHelperRegistry, MetaPropertyValueFormatterRegistry, atg.repository.xml.ModifyService, MultiAccessController, NonTransientAccessController, NoTaxCalculator, NucleusAssemblerFactory, OrderManager, OrderMarkerManager, OrderMarkerServices, OrderMergeListenerImpl, OrderServices, OrderSubtotalCalculator, OrderTools, atg.repository.PagedQueryIteratorFactory, PaymentGroupContainerService, PaymentGroupManager, PaymentManager, atg.process.definition.PDLParser, PerApplicationExporter, PersistentCacheManager, PipelinedDataReporter, PipelineManager, PipelinePurgeHandler, atg.core.i18n.PlaceList, PortalManager, PortletFormHandler, PriceListManager, PriceListPairVariantProducer, PriceRestSubresource, PricingContextFactory, PricingEngineService, PricingModelEvaluationSiteVetoer, PricingModelHolder, PricingModelProperties, ProcAdjustSuggestedAmountsForNonReturnItems, ProcApplyChanges, ProcApprovalCompleteAnalyzer, ProcAuthorizePaymentGroups, ProcCalculateNewAmounts, ProcCalculateReturnFee, ProcCalculateSuggestedRefunds, ProcCheckRequisitionNumbers, ProcCloneOrderForEdit, ProcCreateCreditCardInfo, ProcCreateGiftCertificateInfo, ProcCreateInStorePaymentInfo, ProcCreateInvoiceRequestInfo, ProcCreateReplacementOrderPaymentGroups, ProcCreateReplacementOrderShippingGroups, ProcCreateReturnItemList, ProcCreateStoreCreditInfo, ProcDispatchOnOrderState, ProcDispatchOnProperty, ProcExecuteSubmitReplacementOrder, ProcGenerateItemCostAdjustments, ProcGenerateReplacementOrder, ProcHandleModificationClassType, ProcInitializeCloneEditState, ProcInitializeReconciliation, ProcInitializeRefundMethods, atg.commerce.csr.returns.ProcInitializeReturnRequestProperties, ProcInitPreReturnPromotionValues, ProcInitReturnAdjustedOrder, ProcInitReturnCalculationOrder, ProcInitShippingCostShares, ProcInstantiateReplacementOrder, ProcLoadReplacementOrders, ProcMarkReturnRequestAsProcessed, ProcPopulatePipelineParams, ProcPrepareReplacementOrderToSubmit, ProcProcessPaymentGroup, ProcPropertyRestriction, ProcReconcileGiftlistRepository, ProcRemoveUnallocatedRefundMethods, ProcResetGWPMetaData, ProcResetRefundAmounts, ProcReturnCommerceItems, ProcSaveQuoteInfo, ProcSaveReturnRequestToRepository, ProcSendFulfillmentNotifications, ProcSendScheduledOrderMessage, ProcSetActualRefundsFromSuggestedRefunds, ProcSetItemPriceSources, ProcSetOriginatingOrder, ProcSetOriginOfReplacementOrder, ProcSetPricelists, ProcSetPromotions, ProcSetReturnShipmentRequired, ProcSettleCredits, ProcSettleReturnRequest, ProcSubmitReplacementOrder, ProcUpdateCatalogRefOfProfile, ProcUpdateInventoryOnReceive, ProcUpdateReplacementOrderStateOnConfirm, ProcUpdateReturnItemOnReceive, ProcUpdateReturnRequestState, ProcUpdateStateOfReturnItems, ProcUpdateStoreCreditAllocations, ProcValidateCloneOrder, ProcValidateRefundMethodAllocations, ProcValidateSelectedItems, ProductInventoryCollector, Profile, ProfileMarkerServices, ProfilePropertySetter, ProfileRealmManager, ProfileRequest, ProfileRequestTools, ProfileServices, ProfileSessionFailService, ProfileTools, ProjectPropertyAccessor, PromotionImportExport, PromotionImportExportTools, PromotionRestResource, PromotionTemplateManager, PromotionTemplateTools, PromotionTemplateValidator, PromotionTools, atg.repository.search.indexing.PropertyAccessorImpl, PropertyTools, PublishingWorkflowAutomator, PurchaseProcessHelper, PurgeExecutor, PushedSiteParamFilter, Qualifier, QueueingLogger, QueueingPropertiesChangeListener, RecordFilterBuilderImpl, atg.endeca.index.RecordSubmitterImpl, RecurringDeploymentService, RefinementConfigurationGenerator, RefinementConfigurationPropertyManager, RefinementElementPropertyManager, atg.nucleus.RegisteredService, RelationsRegistry, RemoveService, RepeatingRequestMonitor, RepositoryImpl, RepositoryItemPurgeProcessor, atg.repository.search.indexing.RepositoryLockingService, RepositoryMarkerManager, RepositoryProfileItemFinder, RepositoryServices, RepositoryUtils.Service, RepositoryXMLTools, RequestServerMonitor, ResourcePool, RestConfiguration, RestInputCustomizerImpl, RestOutputCustomizerImpl, RestResolver, RestResourceRegistry, RestSecurityManager, RestUtils, ReturnManager, ReturnTools, RuleAccessController, RuleEvaluator, RuleSetEvaluator, SampleToLogEvent, SaveCommerceC2CSessionData, SchedulableService, Scheduler, ScriptRunner, SearchConfigurationPropertyManager, SearchContext, SearchDimensionManagerService, SearchMerchandisingConstants, SearchQueryCache, SearchTestingEnvironment, SearchTestingPropertyManager, SearchUpdateXMLGenerator, SecurityProviderService, SelectorReplacementValueProducer, SessionConfirmation, SessionInfo, SetPaymentDueDate, ShareableType, ShippingCalculatorImpl, ShippingGroupContainerService, ShippingGroupManager, SimpleIndexingAdmin, SimpleInvoiceMessageSink, SimpleSOAPClient, SiteContextManager, SiteGroupManager, SiteManager, SitemapIndexGenerator, SitemapTools, SiteSessionManager, SiteURLManager, SKUInventoryCollector, Slot, atg.dms.forward.SourceSinkTemplate, SQLImporter, SQLTableLogger, StandardCollectorFactory, StandardSecurityPolicy, StaticSitemapGenerator, StoreCreditProcessorImpl, StoreService, SubCatalogsGeneratorService, SwitchingDataSource, TableInfo, TargetingResults, TargetingServices, TargetingSourceMap, TaxProcessorTaxCalculator, TemplateEmailSender, TimedOperationService, TransactionLockFactory, UnitOfMeasure, UnitOfMeasureManager, URLPatternMatchingRuleFilter, UrlTemplate, UrlTemplateMapperImpl, UserCreditCardAuthorizer, UserDirectoryTools, UserDirectoryUserAuthority, UserFailService, UserGiftCertificateAuthorizer, UserInvoiceRequestAuthorizer, UserLoginManager, UserRestResource, UserStoreCreditAuthorizer, ValidateMarkerByPossibleValue, VariableRankingPropertyProvider, VersioningLayerTools, VersionManager, VMSystem, WebAppRegistry, WorkingContext.WorkingContextService, XAOnlyDataSource
```
public class GenericService
extends VariableArgumentApplicationLoggingImpl
implements NameContextBindingListener, ComponentNameResolver, NameContextElement, ServiceListener, Service, atg.nucleus.logging.ApplicationLoggingSender, AdminableService, atg.naming.NameContextParentable, atg.naming.AbsoluteNameable, atg.nucleus.Configured
```
A GenericService is a basic implementation of the Service interfaces. Services written from scratch should extend this class to take advantage of all the facilities it provides:
- Implementation of the Service methods, thereby allowing Nucleus to send start and stop notifications to the Service.
- Implementation of ApplicationLogging, allowing the Service to log messages and errors to attached "LogListeners".
- Implementation of NameContextElement, allowing this Service to know its position in the naming hierarchy.
A GenericService provides two methods that subclasses should override:
- doStartService() This is called after a Service has been created, placed into the correct naming hierarchy, and all of its properties have been set. A Service should use this method to start any processes required for its operation.
- doStopService() This is called whenever Nucleus determines that a Service must be shut down. This might happen because of an explicit command from the administrator, or it may happen because Nucleus is shutting down. This is also called when a Service is reconfigured. In such a case, doStopService() is called, then the appropriate properties are set with the new configuration values, and doStartService() is called.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static java.lang.String`	`SERVICE_INFO_KEY` Should be used as a key to retrieve the serviceInfo property from ResourceBundles

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors
Constructor and Description

GenericService()
Constructs a new GenericService

Constructors
Constructor and Description
`GenericService()` Constructs a new GenericService

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLogListener(LogListener pListener)` Adds a listener to the list of log listeners
`protected javax.servlet.Servlet`	`createAdminServlet()` Creates and returns a new Servlet that will administer this service.
`void`	`doStartService()` This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
`void`	`doStopService()` This is called when a Service is required to shut down.
`java.lang.String`	`getAbsoluteName()` Returns the absolute name of this service, using Nucleus to get the absolute name.
`javax.servlet.Servlet`	`getAdminServlet()` Returns the Servlet that will handle requests directed at this service.
`java.lang.String`	`getAdminServletOutputStreamEncoding()` get AdminServletOutputStreamEncoding - This determines the character encoding for the PrintWriter when the AdminServlet writes data to the response
`protected ApplicationLogging`	`getLoggingForVlogging()` Get the ApplicationLogging instance to use for vlog methods.
`int`	`getLogListenerCount()` Returns the number of log listeners
`LogListener[]`	`getLogListeners()` Returns the list of log listeners as an array property.
`java.lang.String`	`getName()` Returns the name by which this element is know within its enclosing NameContext.
`NameContext`	`getNameContext()` Returns the NameContext into which this element has been bound, or null if the element is not bound in a NameContext.
`Nucleus`	`getNucleus()` Returns the Nucleus managing this Service
`NameContext`	`getRoot()` Searches up the tree until it finds the root NameContext
`Configuration`	`getServiceConfiguration()` Returns the Configuration that was used to create this Service, null if there was none.
`java.lang.String`	`getServiceInfo()` Returns the a descriptive string about this service
`boolean`	`isAdminServletUseServletOutputStream()` get AdminServletUseServletOutputStream - This flag determines whether the AdminServlet should write data to the response using a ServletOutputStream or a PrintWriter.
`boolean`	`isLoggingDebug()` This method returns whether or not an debug log event should be broadcast.
`boolean`	`isLoggingError()` This method returns whether or not an error log event should be broadcast.
`boolean`	`isLoggingInfo()` This method returns whether or not an info log event should be broadcast.
`boolean`	`isLoggingTrace()` This method returns whether or not an trace log event should be broadcast.
`boolean`	`isLoggingWarning()` This method returns whether or not an warning log event should be broadcast.
`boolean`	`isRunning()` Returns true if this Service is currently running.
`void`	`logDebug(java.lang.String pMessage)` Logs an debug event with the specified message
`void`	`logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an debug event with the specified message and Throwable
`void`	`logDebug(java.lang.Throwable pThrowable)` Logs an debug event with the specified Throwable
`void`	`logError(java.lang.String pMessage)` Logs an error event with the specified message
`void`	`logError(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an error event with the specified message and Throwable
`void`	`logError(java.lang.Throwable pThrowable)` Logs an error event with the specified Throwable
`void`	`logInfo(java.lang.String pMessage)` Logs an info event with the specified message
`void`	`logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an info event with the specified message and Throwable
`void`	`logInfo(java.lang.Throwable pThrowable)` Logs an info event with the specified Throwable
`void`	`logTrace(java.lang.String pMessage)` Logs an trace event with the specified message
`void`	`logTrace(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an trace event with the specified message and Throwable
`void`	`logTrace(java.lang.Throwable pThrowable)` Logs an trace event with the specified Throwable
`void`	`logWarning(java.lang.String pMessage)` Logs an warning event with the specified message
`void`	`logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an warning event with the specified message and Throwable
`void`	`logWarning(java.lang.Throwable pThrowable)` Logs an warning event with the specified Throwable
`void`	`nameContextElementBound(NameContextBindingEvent pEvent)` This is called to notify this context that it is being bound into a NameContext.
`void`	`nameContextElementUnbound(NameContextBindingEvent pEvent)` This is called to notify this context that it is being unbound from a NameContext.
`void`	`removeLogListener(LogListener pListener)` Removes a listener from the list of log listeners
`protected java.lang.Object`	`reResolveThis()` Return this service, but re-resolved in our current name context.
`java.lang.Object`	`resolveName(ComponentName pName)` Resolves the specified name, relative to this context's parent.
`java.lang.Object`	`resolveName(ComponentName pName, boolean pCreate)` Resolves the specified name, relative to this context's parent.
`java.lang.Object`	`resolveName(java.lang.String pName)` Resolves the specified name, relative to this context's parent.
`java.lang.Object`	`resolveName(java.lang.String pName, boolean pCreate)` Resolves the specified name, relative to this context's parent.
`void`	`sendLogEvent(LogEvent pLogEvent)` Sends a LogEvent to all of the listeners
`void`	`setAdminServletOutputStreamEncoding(java.lang.String pAdminServletOutputStreamEncoding)` set AdminServletOutputStreamEncoding - This determines the character encoding for the PrintWriter when the AdminServlet writes data to the response
`void`	`setAdminServletUseServletOutputStream(boolean pAdminServletUseServletOutputStream)` set AdminServletUseServletOutputStream - This flag determines whether the AdminServlet should write data to the response using a ServletOutputStream or a PrintWriter.
`void`	`setLoggingDebug(boolean pLogging)` Sets whether or not debug log events should be logged.
`void`	`setLoggingError(boolean pLogging)` Sets whether or not error log events should be logged.
`void`	`setLoggingInfo(boolean pLogging)` Sets whether or not info log events should be logged.
`void`	`setLoggingTrace(boolean pLogging)` Sets whether or not trace log events should be logged.
`void`	`setLoggingWarning(boolean pLogging)` Sets whether or not warning log events should be logged.
`void`	`setNucleus(Nucleus pNucleus)` Sets the Nucleus managing this Service
`void`	`setServiceInfo(java.lang.String pServiceInfo)` Sets the a descriptive string about this service
`void`	`startService(ServiceEvent pEvent)` Starts the service running.
`void`	`stopService()` Stops the service.
`java.lang.String`	`toString()` Return a toString that includes the name of the component, if available.

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - SERVICE_INFO_KEY
```
public static final java.lang.String SERVICE_INFO_KEY
```
    Should be used as a key to retrieve the serviceInfo property from ResourceBundles
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GenericService
```
public GenericService()
```
    Constructs a new GenericService
- Method Detail
  - setAdminServletOutputStreamEncoding
```
public void setAdminServletOutputStreamEncoding(java.lang.String pAdminServletOutputStreamEncoding)
```
    set AdminServletOutputStreamEncoding - This determines the character encoding for the PrintWriter when the AdminServlet writes data to the response
    
    Parameters:
    
    pAdminServletOutputStreamEncoding - the AdminServletOutputStreamEncoding
  - getAdminServletOutputStreamEncoding
```
public java.lang.String getAdminServletOutputStreamEncoding()
```
    get AdminServletOutputStreamEncoding - This determines the character encoding for the PrintWriter when the AdminServlet writes data to the response
    
    Returns:
    
    the AdminServletOutputStreamEncoding
  - setAdminServletUseServletOutputStream
```
public void setAdminServletUseServletOutputStream(boolean pAdminServletUseServletOutputStream)
```
    set AdminServletUseServletOutputStream - This flag determines whether the AdminServlet should write data to the response using a ServletOutputStream or a PrintWriter. If true, a ServletOutputStream is used, if false, a PrintWriter is used. The adminServletOutputStreamEncoding property is only used if this value is set to false.
    
    Parameters:
    
    pAdminServletUseServletOutputStream - the AdminServletUseServletOutputStream
  - isAdminServletUseServletOutputStream
```
public boolean isAdminServletUseServletOutputStream()
```
    get AdminServletUseServletOutputStream - This flag determines whether the AdminServlet should write data to the response using a ServletOutputStream or a PrintWriter. If true, a ServletOutputStream is used, if false, a PrintWriter is used. The adminServletOutputStreamEncoding property is only used if this value is set to false.
    
    Returns:
    
    the AdminServletUseServletOutputStream
  - getRoot
```
public NameContext getRoot()
```
    Searches up the tree until it finds the root NameContext
  - doStartService
```
public void doStartService()
                    throws ServiceException
```
    This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.
    
    Throws:
    
    ServiceException - if the Service had a problem starting up
  - doStopService
```
public void doStopService()
                   throws ServiceException
```
    This is called when a Service is required to shut down. The Service should respond by stopping any processes that it has started.
    
    Throws:
    
    ServiceException - if the Service had a problem shutting down
  - getServiceInfo
```
public java.lang.String getServiceInfo()
```
    Returns the a descriptive string about this service
  - setServiceInfo
```
public void setServiceInfo(java.lang.String pServiceInfo)
```
    Sets the a descriptive string about this service
  - addLogListener
```
public void addLogListener(LogListener pListener)
```
    Adds a listener to the list of log listeners
    
    Specified by:
    
    addLogListener in interface atg.nucleus.logging.ApplicationLoggingSender
  - removeLogListener
```
public void removeLogListener(LogListener pListener)
```
    Removes a listener from the list of log listeners
    
    Specified by:
    
    removeLogListener in interface atg.nucleus.logging.ApplicationLoggingSender
  - getLogListeners
```
public LogListener[] getLogListeners()
```
    Returns the list of log listeners as an array property.
    
    Specified by:
    
    getLogListeners in interface atg.nucleus.logging.ApplicationLoggingSender
  - getLogListenerCount
```
public int getLogListenerCount()
```
    Returns the number of log listeners
    
    Specified by:
    
    getLogListenerCount in interface atg.nucleus.logging.ApplicationLoggingSender
  - sendLogEvent
```
public void sendLogEvent(LogEvent pLogEvent)
```
    Sends a LogEvent to all of the listeners
  - resolveName
```
public java.lang.Object resolveName(ComponentName pName,
                                    boolean pCreate)
```
    Resolves the specified name, relative to this context's parent.
    
    Parameters:
    
    pName - the name to be resolved
    
    pCreate - flag indicating whether Nucleus should attempt to create the object if it does not already exist in the naming hierarchy.
    
    Returns:
    
    the Object to which the name resolves, or null if the name could not be resolved. Any errors that occur are directed to listeners of the Nucleus.
  - resolveName
```
public java.lang.Object resolveName(java.lang.String pName,
                                    boolean pCreate)
```
    Resolves the specified name, relative to this context's parent. This method should only be called on globally scoped components.
    
    Parameters:
    
    pName - the name to be resolved
    
    pCreate - flag indicating whether Nucleus should attempt to create the object if it does not already exist in the naming hierarchy.
    
    Returns:
    
    the Object to which the name resolves, or null if the name could not be resolved. Any errors that occur are directed to listeners of the Nucleus.
  - resolveName
```
public java.lang.Object resolveName(ComponentName pName)
```
    Resolves the specified name, relative to this context's parent. This will attempt to create the service for the specified name if it does not already exist. This method should only be called on globally scoped components.
    
    Specified by:
    
    resolveName in interface ComponentNameResolver
    
    Parameters:
    
    pName - the name to be resolved
    
    Returns:
    
    the Object to which the name resolves, or null if the name could not be resolved. Any errors that occur are directed to listeners of the Nucleus.
  - resolveName
```
public java.lang.Object resolveName(java.lang.String pName)
```
    Resolves the specified name, relative to this context's parent. This will attempt to create the service for the specified name if it does not already exist.
    
    Specified by:
    
    resolveName in interface NameResolver
    
    Parameters:
    
    pName - the name to be resolved
    
    Returns:
    
    the Object to which the name resolves, or null if the name could not be resolved. Any errors that occur are directed to listeners of the Nucleus.
  - getAbsoluteName
```
public java.lang.String getAbsoluteName()
```
    Returns the absolute name of this service, using Nucleus to get the absolute name.
    
    Specified by:
    
    getAbsoluteName in interface atg.naming.AbsoluteNameable
  - nameContextElementBound
```
public void nameContextElementBound(NameContextBindingEvent pEvent)
```
    This is called to notify this context that it is being bound into a NameContext.
    
    Specified by:
    
    nameContextElementBound in interface NameContextBindingListener
  - nameContextElementUnbound
```
public void nameContextElementUnbound(NameContextBindingEvent pEvent)
```
    This is called to notify this context that it is being unbound from a NameContext.
    
    Specified by:
    
    nameContextElementUnbound in interface NameContextBindingListener
  - getNameContext
```
public NameContext getNameContext()
```
    Returns the NameContext into which this element has been bound, or null if the element is not bound in a NameContext.
    
    Specified by:
    
    getNameContext in interface NameContextElement
    
    Specified by:
    
    getNameContext in interface atg.naming.NameContextParentable
  - getName
```
public java.lang.String getName()
```
    Returns the name by which this element is know within its enclosing NameContext.
    
    Specified by:
    
    getName in interface NameContextElement
  - startService
```
public void startService(ServiceEvent pEvent)
                  throws ServiceException
```
    Starts the service running. This will be called after the service has been placed into the naming hierarchy, and all of its properties have been set.
    
    Specified by:
    
    startService in interface ServiceListener
    
    Parameters:
    
    pEvent - the ServiceEvent encapsulating information about the Service's environment and configuration
    
    Throws:
    
    ServiceException - if an error occurred while attempting to start the service.
  - stopService
```
public void stopService()
                 throws ServiceException
```
    Stops the service. This will be called when the Service is being shut down, either by explicit instructions from the administrator, or for various other reasons. A Service should clean up any resources it is using, but should be prepared to restart itself. When asked to restart, its properties may have changed.
    
    Specified by:
    
    stopService in interface ServiceListener
    
    Throws:
    
    ServiceException - if an error occurred while attempting to stop the service.
  - getNucleus
```
public Nucleus getNucleus()
```
    Returns the Nucleus managing this Service
    
    Specified by:
    
    getNucleus in interface Service
  - setNucleus
```
public void setNucleus(Nucleus pNucleus)
```
    Sets the Nucleus managing this Service
  - getServiceConfiguration
```
public Configuration getServiceConfiguration()
```
    Returns the Configuration that was used to create this Service, null if there was none.
    
    Specified by:
    
    getServiceConfiguration in interface atg.nucleus.Configured
    
    Specified by:
    
    getServiceConfiguration in interface Service
  - isRunning
```
public boolean isRunning()
```
    Returns true if this Service is currently running.
    
    Specified by:
    
    isRunning in interface Service
  - isLoggingInfo
```
public boolean isLoggingInfo()
```
    This method returns whether or not an info log event should be broadcast.
    
    Specified by:
    
    isLoggingInfo in interface atg.core.logging.Logging
    
    Specified by:
    
    isLoggingInfo in interface ApplicationLogging
    
    Returns:
    
    boolean true if info log events should be logged
    false if info log events should not be logged
  - setLoggingInfo
```
public void setLoggingInfo(boolean pLogging)
```
    Sets whether or not info log events should be logged.
    
    Specified by:
    
    setLoggingInfo in interface atg.core.logging.Logging
    
    Specified by:
    
    setLoggingInfo in interface ApplicationLogging
  - isLoggingWarning
```
public boolean isLoggingWarning()
```
    This method returns whether or not an warning log event should be broadcast.
    
    Specified by:
    
    isLoggingWarning in interface atg.core.logging.Logging
    
    Specified by:
    
    isLoggingWarning in interface ApplicationLogging
    
    Returns:
    
    boolean true if warning log events should be logged
    false if warning log events should not be logged
  - setLoggingWarning
```
public void setLoggingWarning(boolean pLogging)
```
    Sets whether or not warning log events should be logged.
    
    Specified by:
    
    setLoggingWarning in interface atg.core.logging.Logging
    
    Specified by:
    
    setLoggingWarning in interface ApplicationLogging
  - isLoggingError
```
public boolean isLoggingError()
```
    This method returns whether or not an error log event should be broadcast.
    
    Specified by:
    
    isLoggingError in interface atg.core.logging.Logging
    
    Specified by:
    
    isLoggingError in interface ApplicationLogging
    
    Returns:
    
    boolean true if error log events should be logged
    false if error log events should not be logged
  - setLoggingError
```
public void setLoggingError(boolean pLogging)
```
    Sets whether or not error log events should be logged.
    
    Specified by:
    
    setLoggingError in interface atg.core.logging.Logging
    
    Specified by:
    
    setLoggingError in interface ApplicationLogging
  - isLoggingDebug
```
public boolean isLoggingDebug()
```
    This method returns whether or not an debug log event should be broadcast.
    
    Specified by:
    
    isLoggingDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    isLoggingDebug in interface ApplicationLogging
    
    Returns:
    
    boolean true if debug log events should be logged
    false if debug log events should not be logged
  - setLoggingDebug
```
public void setLoggingDebug(boolean pLogging)
```
    Sets whether or not debug log events should be logged.
    
    Specified by:
    
    setLoggingDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    setLoggingDebug in interface ApplicationLogging
  - isLoggingTrace
```
public boolean isLoggingTrace()
```
    This method returns whether or not an trace log event should be broadcast.
    
    Specified by:
    
    isLoggingTrace in interface atg.core.logging.TraceLogging
    
    Specified by:
    
    isLoggingTrace in interface atg.nucleus.logging.TraceApplicationLogging
    
    Overrides:
    
    isLoggingTrace in class VariableArgumentApplicationLoggingImpl
    
    Returns:
    
    boolean true if trace log events should be logged
    false if trace log events should not be logged
  - setLoggingTrace
```
public void setLoggingTrace(boolean pLogging)
```
    Sets whether or not trace log events should be logged.
    
    Specified by:
    
    setLoggingTrace in interface atg.core.logging.TraceLogging
    
    Specified by:
    
    setLoggingTrace in interface atg.nucleus.logging.TraceApplicationLogging
  - logInfo
```
public void logInfo(java.lang.String pMessage)
```
    Logs an info event with the specified message
    
    Specified by:
    
    logInfo in interface atg.core.logging.Logging
    
    Specified by:
    
    logInfo in interface ApplicationLogging
  - logInfo
```
public void logInfo(java.lang.Throwable pThrowable)
```
    Logs an info event with the specified Throwable
    
    Specified by:
    
    logInfo in interface atg.core.logging.Logging
    
    Specified by:
    
    logInfo in interface ApplicationLogging
  - logInfo
```
public void logInfo(java.lang.String pMessage,
                    java.lang.Throwable pThrowable)
```
    Logs an info event with the specified message and Throwable
    
    Specified by:
    
    logInfo in interface atg.core.logging.Logging
    
    Specified by:
    
    logInfo in interface ApplicationLogging
  - logWarning
```
public void logWarning(java.lang.String pMessage)
```
    Logs an warning event with the specified message
    
    Specified by:
    
    logWarning in interface atg.core.logging.Logging
    
    Specified by:
    
    logWarning in interface ApplicationLogging
  - logWarning
```
public void logWarning(java.lang.Throwable pThrowable)
```
    Logs an warning event with the specified Throwable
    
    Specified by:
    
    logWarning in interface atg.core.logging.Logging
    
    Specified by:
    
    logWarning in interface ApplicationLogging
  - logWarning
```
public void logWarning(java.lang.String pMessage,
                       java.lang.Throwable pThrowable)
```
    Logs an warning event with the specified message and Throwable
    
    Specified by:
    
    logWarning in interface atg.core.logging.Logging
    
    Specified by:
    
    logWarning in interface ApplicationLogging
  - logError
```
public void logError(java.lang.String pMessage)
```
    Logs an error event with the specified message
    
    Specified by:
    
    logError in interface atg.core.logging.Logging
    
    Specified by:
    
    logError in interface ApplicationLogging
  - logError
```
public void logError(java.lang.Throwable pThrowable)
```
    Logs an error event with the specified Throwable
    
    Specified by:
    
    logError in interface atg.core.logging.Logging
    
    Specified by:
    
    logError in interface ApplicationLogging
  - logError
```
public void logError(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
```
    Logs an error event with the specified message and Throwable
    
    Specified by:
    
    logError in interface atg.core.logging.Logging
    
    Specified by:
    
    logError in interface ApplicationLogging
  - logDebug
```
public void logDebug(java.lang.String pMessage)
```
    Logs an debug event with the specified message
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
  - logDebug
```
public void logDebug(java.lang.Throwable pThrowable)
```
    Logs an debug event with the specified Throwable
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
  - logDebug
```
public void logDebug(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
```
    Logs an debug event with the specified message and Throwable
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
  - logTrace
```
public void logTrace(java.lang.String pMessage)
```
    Logs an trace event with the specified message
    
    Specified by:
    
    logTrace in interface atg.core.logging.TraceLogging
    
    Specified by:
    
    logTrace in interface atg.nucleus.logging.TraceApplicationLogging
  - logTrace
```
public void logTrace(java.lang.Throwable pThrowable)
```
    Logs an trace event with the specified Throwable
    
    Specified by:
    
    logTrace in interface atg.core.logging.TraceLogging
    
    Specified by:
    
    logTrace in interface atg.nucleus.logging.TraceApplicationLogging
  - logTrace
```
public void logTrace(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)
```
    Logs an trace event with the specified message and Throwable
    
    Specified by:
    
    logTrace in interface atg.core.logging.TraceLogging
    
    Specified by:
    
    logTrace in interface atg.nucleus.logging.TraceApplicationLogging
  - getAdminServlet
```
public javax.servlet.Servlet getAdminServlet()
```
    Returns the Servlet that will handle requests directed at this service. This will first check to see if the servlet is already created, and if not it will create it by calling createAdminServlet.
    
    Specified by:
    
    getAdminServlet in interface AdminableService
    
    See Also:
    
    createAdminServlet()
  - createAdminServlet
```
protected javax.servlet.Servlet createAdminServlet()
```
    Creates and returns a new Servlet that will administer this service. By default, this creates a ServiceAdminServlet, but subclasses may create their own servlets.
  - reResolveThis
```
protected java.lang.Object reResolveThis()
```
    Return this service, but re-resolved in our current name context. This method should be used to pass "this" to admin servlets.
    
    Returns:
    
    either this service, re-resolved in our current name context, or if that fails, then this.
  - getLoggingForVlogging
```
protected ApplicationLogging getLoggingForVlogging()
```
    Get the ApplicationLogging instance to use for vlog methods.
    
    Specified by:
    
    getLoggingForVlogging in class VariableArgumentApplicationLoggingImpl
  - toString
```
public java.lang.String toString()
```
    Return a toString that includes the name of the component, if available.
    
    Overrides:
    
    toString in class java.lang.Object

Class GenericService

Field Summary

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

SERVICE_INFO_KEY

Constructor Detail

GenericService

Method Detail

setAdminServletOutputStreamEncoding

getAdminServletOutputStreamEncoding

setAdminServletUseServletOutputStream

isAdminServletUseServletOutputStream

getRoot

doStartService

doStopService

getServiceInfo

setServiceInfo

addLogListener

removeLogListener

getLogListeners

getLogListenerCount

sendLogEvent

resolveName

resolveName

resolveName

resolveName

getAbsoluteName

nameContextElementBound

nameContextElementUnbound

getNameContext

getName

startService

stopService

getNucleus

setNucleus

getServiceConfiguration

isRunning

isLoggingInfo

setLoggingInfo

isLoggingWarning

setLoggingWarning

isLoggingError

setLoggingError

isLoggingDebug

setLoggingDebug

isLoggingTrace

setLoggingTrace

logInfo

logInfo

logInfo

logWarning

logWarning

logWarning

logError

logError

logError

logDebug

logDebug

logDebug

logTrace

logTrace

logTrace

getAdminServlet

createAdminServlet

reResolveThis

getLoggingForVlogging

toString