@ComponentProfile(summary="Create the query portion of a URL from metadata", tag="service,metadata,http,https") public class CreateQueryStringFromMetadata extends ServiceImp
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.
log
CONFIRMATION_ID_KEY
Constructor and Description |
---|
CreateQueryStringFromMetadata() |
Modifier and Type | Method and Description |
---|---|
void |
addMetadataKey(java.lang.String key)
Deprecated.
since 3.7.1 use a metadata-filter instead
|
protected void |
closeService() |
void |
doService(AdaptrisMessage msg)
Apply the service to the message.
|
java.lang.Boolean |
getIncludeQueryPrefix() |
MetadataFilter |
getMetadataFilter() |
java.util.List<java.lang.String> |
getMetadataKeys()
Deprecated.
since 3.7.1 use a metadata-filter instead
|
java.lang.String |
getQuerySeparator() |
java.lang.String |
getResultKey() |
protected void |
initService() |
void |
prepare()
Prepare for initialisation.
|
void |
setIncludeQueryPrefix(java.lang.Boolean b)
Whether or not to include the standard query prefix
|
void |
setMetadataFilter(MetadataFilter metadataFilter) |
void |
setMetadataKeys(java.util.List<java.lang.String> metadataKeys)
Deprecated.
since 3.7.1 use a metadata-filter instead
|
void |
setQuerySeparator(java.lang.String s)
Set the separator to be used in between each parameter in the query String..
|
void |
setResultKey(java.lang.String resultKey) |
changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop
public void doService(AdaptrisMessage msg) throws ServiceException
Service
Apply the service to the message.
msg
- the AdaptrisMessage
to processServiceException
- wrapping any underlying Exception
sprotected void initService() throws CoreException
initService
in class ServiceImp
CoreException
protected void closeService()
closeService
in class ServiceImp
public MetadataFilter getMetadataFilter()
public void setMetadataFilter(MetadataFilter metadataFilter)
@Deprecated @Removal(version="3.9.0", message="Use metadata-filter") public void addMetadataKey(java.lang.String key)
@Deprecated @Removal(version="3.9.0", message="Use metadata-filter") public java.util.List<java.lang.String> getMetadataKeys()
@Deprecated @Removal(version="3.9.0", message="Use metadata-filter") public void setMetadataKeys(java.util.List<java.lang.String> metadataKeys)
public java.lang.String getResultKey()
public void setResultKey(java.lang.String resultKey)
public java.lang.String getQuerySeparator()
public void setQuerySeparator(java.lang.String s)
Although '&' is the conventional standard (or even a semi-colon ';'), there isn't a formal standard for separating query parameters; RFC3986 simply states:
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
query = *( pchar / "/" / "?" )
s
- the querySeparator to set, defaults to null which indicates '&'.public void prepare() throws CoreException
ComponentLifecycleExtension
CoreException
public java.lang.Boolean getIncludeQueryPrefix()
public void setIncludeQueryPrefix(java.lang.Boolean b)
b
-