Class CreateQueryStringFromMetadata
- java.lang.Object
-
- com.adaptris.core.ServiceImp
-
- com.adaptris.core.services.metadata.UrlEncodedMetadataValues
-
- com.adaptris.core.services.metadata.CreateQueryStringFromMetadata
-
- All Implemented Interfaces:
AdaptrisComponent,ComponentLifecycle,ComponentLifecycleExtension,MessageEventGenerator,Service,StateManagedComponent
@ComponentProfile(summary="Create the query portion of a URL from metadata", tag="service,metadata,http,https") public class CreateQueryStringFromMetadata extends UrlEncodedMetadataValuesService that creates a URL query string from the specified metadata keys.In the adapter configuration file this class is aliased as create-query-string-from-metadata which is the preferred alternative to the fully qualified classname when building your configuration.
-
-
Field Summary
-
Fields inherited from class com.adaptris.core.services.metadata.UrlEncodedMetadataValues
AMPERSAND
-
Fields inherited from class com.adaptris.core.ServiceImp
log
-
-
Constructor Summary
Constructors Constructor Description CreateQueryStringFromMetadata()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddoService(AdaptrisMessage msg)Apply the service to the message.java.lang.BooleangetIncludeQueryPrefix()java.lang.StringgetResultKey()voidprepare()Prepare for initialisation.voidsetIncludeQueryPrefix(java.lang.Boolean b)Whether or not to include the standard query prefixvoidsetResultKey(java.lang.String resultKey)-
Methods inherited from class com.adaptris.core.services.metadata.UrlEncodedMetadataValues
buildEncodedString, closeService, getMetadataFilter, getSeparator, initService, separator, setMetadataFilter, setSeparator, withMetadataFilter, withQuerySeparator
-
Methods inherited from class com.adaptris.core.ServiceImp
changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop
-
-
-
-
Method Detail
-
prepare
public void prepare() throws CoreExceptionDescription copied from interface:ComponentLifecycleExtensionPrepare for initialisation.- Specified by:
preparein interfaceComponentLifecycleExtension- Overrides:
preparein classUrlEncodedMetadataValues- Throws:
CoreException
-
doService
public void doService(AdaptrisMessage msg) throws ServiceException
Description copied from interface:ServiceApply the service to the message.
- Parameters:
msg- theAdaptrisMessageto process- Throws:
ServiceException- wrapping any underlyingExceptions
-
getResultKey
public java.lang.String getResultKey()
-
setResultKey
public void setResultKey(java.lang.String resultKey)
-
getIncludeQueryPrefix
public java.lang.Boolean getIncludeQueryPrefix()
-
setIncludeQueryPrefix
public void setIncludeQueryPrefix(java.lang.Boolean b)
Whether or not to include the standard query prefix- Parameters:
b-
-
-