Package com.adaptris.core
Interface Service
- All Superinterfaces:
AdaptrisComponent
,ComponentLifecycle
,ComponentLifecycleExtension
,ConfigComment
,MessageEventGenerator
,StateManagedComponent
- All Known Subinterfaces:
AggregatingConsumeService<T>
,ConnectedService
,DynamicPollingTemplate.TemplateProvider
,ServiceCollection
,ServiceWrapper
- All Known Implementing Classes:
AbstractJdbcSequenceNumberService
,AcknowledgeService
,AddExtendedLoggingContext
,AddFormattedMetadataService
,AddLoggingContext
,AddMetadataService
,AddNamespaceObjectMetadata
,AddPayloadService
,AddTimestampMetadataService
,AddToCacheService
,AddValueToCache
,AdvancedMessageSplitterService
,AggregatingConsumeServiceImpl
,AggregatingFsConsumeService
,AggregatingFtpConsumeService
,AggregatingJmsConsumeService
,AlwaysFailService
,Base64DecodeMetadataService
,Base64DecodeService
,Base64EncodeMetadataService
,Base64EncodeService
,Base64MetadataService
,Base64Service
,BasicMessageSplitterService
,BranchingHttpRequestService
,BranchingServiceCollection
,BranchingServiceEnabler
,BranchingServiceImp
,CacheServiceBase
,CacheServiceImpl
,ChangeCharEncodingService
,CheckAndRetrieve
,CheckCacheService
,CheckMetadataValueService
,CheckUniqueMetadataValueService
,ClearCacheService
,ClearExceptionService
,ClearLoggingContext
,CloneMessageServiceList
,ConvertObjectMetadataService
,CopyMetadataService
,CoreSecurityService
,CreateQueryStringFromMetadata
,DecodingService
,DecryptionService
,DoWhile
,DuplicateMessageRoutingService
,DuplicateMetadataValueService
,DynamicJmxOperationService
,DynamicServiceExecutor
,DynamicSharedService
,EncodingService
,EncryptionOnlyService
,EncryptionService
,EncryptionSigningService
,ExceptionHandlingServiceWrapper
,ExceptionReportService
,ExtractMetadataService
,FindAndReplaceService
,FlattenMimeParts
,ForEach
,FormDataFromMetadata
,FormDataToMetadata
,GenerateUniqueMetadataValueService
,GetAndCacheOauthToken
,GetOauthToken
,GetValueFromCache
,GunzipService
,GzipService
,HexToStringService
,HttpRequestService
,HttpRequestServiceImpl
,IfElse
,InputOutputService
,JdbcBatchingDataCaptureService
,JdbcDataCaptureService
,JdbcDataCaptureServiceImpl
,JdbcDataQueryService
,JdbcIteratingDataCaptureServiceImpl
,JdbcMapInsert
,JdbcMapUpsert
,JdbcRawDataCaptureService
,JdbcService
,JdbcServiceList
,JdbcServiceWithParameters
,JettyResponseService
,JettyRoutingService
,JmxOperationCallService
,JmxOperationImpl
,JmxOperationServiceImpl
,JmxWaitService
,LoggingService
,LoggingServiceImpl
,LogMessageService
,MapMetadataService
,MessageSplitterServiceImp
,MetadataAppenderService
,MetadataBranchingServiceImp
,MetadataComparisonService
,MetadataExistsBranchingService
,MetadataFilterService
,MetadataHashingService
,MetadataIdentitySequenceNumberService
,MetadataKeyToCapitalCase
,MetadataKeyToLowerCase
,MetadataKeyToUpperCase
,MetadataServiceImpl
,MetadataToPayloadService
,MetadataValueBranchingService
,MetadataValueEscapeDoubleQuote
,MetadataValueEscapeSingleQuote
,MetadataValueToLowerCase
,MetadataValueToUpperCase
,MimePartSelector
,MimePartSelectorToMetadata
,MultipartMessageBuilder
,MultiPayloadXmlTransformService
,NullService
,OauthTokenGetter
,PayloadFromTemplateService
,PayloadHashingService
,PayloadPathDecryptionService
,PayloadPathEncryptionService
,PayloadToMetadataService
,PooledSplitJoinService
,PoolingMessageSplitterService
,ReadFileService
,ReadMetadataFromFilesystem
,ReformatDateService
,ReformatMetadata
,ReformatMetadataKey
,RegexpMetadataService
,RegexpService
,RemoveFromCacheService
,RemoveKeyFromCache
,RemoveLoggingContext
,ReplaceMetadataValue
,ResolveExpressionService
,RetrieveFromCacheService
,RetryingServiceWrapper
,RetryMessagesService
,RetryOnceStandaloneProducer
,RetryServiceImp
,RetryStoreDeleteService
,RetryStoreListService
,RetryStoreServiceImpl
,RetryStoreWriteService
,ServiceCollectionImp
,ServiceImp
,ServiceList
,ServiceListBase
,SharedService
,SharedServiceImpl
,ShortCutJettyResponse
,SigningService
,SimpleSequenceNumberService
,SingleKeyCacheService
,SingleKeyValueCacheImpl
,SizeBasedBranchingService
,StandaloneProducer
,StandaloneRequestor
,StatelessServiceWrapper
,StaticIdentitySequenceNumberService
,StopProcessingService
,StoreMessageForRetryService
,StoreMetadataValueService
,StringToHexService
,Switch
,SwitchPayloadService
,SymmetricKeyCryptographyService
,SyntaxBranchingService
,SyntaxRoutingService
,SystemCommandExecutorService
,ThrowExceptionService
,TranscodingService
,TrimMetadataService
,UrlDecodeMetadataService
,UrlEncodedMetadataValues
,UrlEncodeMetadataService
,UseXmlCharsetAsEncodingService
,Utf8BomRemover
,ValidateMetadataService
,VerifyIdentityService
,WaitService
,While
,WriteMetadataToFilesystem
,XmlTransformService
,XmlValidationService
,XpathMetadataService
,XpathObjectMetadataService
,XPathService
public interface Service
extends AdaptrisComponent, MessageEventGenerator, StateManagedComponent, ComponentLifecycleExtension, ConfigComment
Implementations of Service
apply aribtrary functionality to
AdaptrisMessage
s. It is not the responsibility of
implementations of Service
to handle multiple
Thread
s - doService
need not be synchronized.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
If true containers should continue and apply the next configuredService
even if thisService
throws anException
.void
doService
(AdaptrisMessage msg) Apply the service to the message.boolean
Returns true if the implementation supports branching.void
setUniqueId
(String uniqueId) Sets the unique identifier for thisService
.Methods inherited from interface com.adaptris.core.AdaptrisComponent
getUniqueId
Methods inherited from interface com.adaptris.core.ComponentLifecycle
close, init, start, stop
Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension
prepare
Methods inherited from interface com.adaptris.core.ConfigComment
getComments, setComments
Methods inherited from interface com.adaptris.core.MessageEventGenerator
createName, createQualifier, isTrackingEndpoint
Methods inherited from interface com.adaptris.core.StateManagedComponent
changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState
-
Method Details
-
doService
Apply the service to the message.
- Parameters:
msg
- theAdaptrisMessage
to process- Throws:
ServiceException
- wrapping any underlyingException
s
-
setUniqueId
Sets the unique identifier for this
Service
. These unique identifiers are optional but maybe required by some implementations ofServiceCollection
.- Parameters:
uniqueId
- thisService
's unique identifier
-
isBranching
boolean isBranching()Returns true if the implementation supports branching.
- Returns:
- true if the implementation supports branching
- See Also:
-
continueOnFailure
boolean continueOnFailure()If true containers should continue and apply the next configured
Service
even if thisService
throws anException
.- Returns:
- continueOnFail
-