CreateQueryStringFromMetadata (Interlok Core/Base)

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 UrlEncodedMetadataValues
```
Service 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
`void`	`doService(AdaptrisMessage msg)`	Apply the service to the message.
`java.lang.Boolean`	`getIncludeQueryPrefix()`
`java.lang.String`	`getResultKey()`
`void`	`prepare()`	Prepare for initialisation.
`void`	`setIncludeQueryPrefix(java.lang.Boolean b)`	Whether or not to include the standard query prefix
`void`	`setResultKey(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

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

- Constructor Detail
  - CreateQueryStringFromMetadata
```
public CreateQueryStringFromMetadata()
```
- Method Detail
  - prepare
```
public void prepare()
             throws CoreException
```
    Description copied from interface: ComponentLifecycleExtension
    
    Prepare for initialisation.
    
    Specified by:
    
    prepare in interface ComponentLifecycleExtension
    
    Overrides:
    
    prepare in class UrlEncodedMetadataValues
    
    Throws:
    
    CoreException
  - doService
```
public void doService(AdaptrisMessage msg)
               throws ServiceException
```
    Description copied from interface: Service
    
    Apply the service to the message.
    
    Parameters:
    
    msg - the AdaptrisMessage to process
    
    Throws:
    
    ServiceException - wrapping any underlying Exceptions
  - 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 -