UrlEncodedMetadataValues (Interlok Core/Base)

java.lang.Object
- com.adaptris.core.ServiceImp
- - com.adaptris.core.services.metadata.UrlEncodedMetadataValues

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

CreateQueryStringFromMetadata, FormDataFromMetadata
```
public abstract class UrlEncodedMetadataValues
extends ServiceImp
```

Field Summary

Fields
Modifier and Type Field Description

protected static java.lang.String AMPERSAND
- Fields inherited from class com.adaptris.core.ServiceImp
  log

Constructor Summary

Constructors
Constructor Description

UrlEncodedMetadataValues()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`buildEncodedString(AdaptrisMessage msg)`
`protected void`	`closeService()`
`MetadataFilter`	`getMetadataFilter()`
`java.lang.String`	`getSeparator()`
`protected void`	`initService()`
`void`	`prepare()`	Prepare for initialisation.
`protected java.lang.String`	`separator()`
`void`	`setMetadataFilter(MetadataFilter metadataFilter)`
`void`	`setSeparator(java.lang.String s)`	Set the separator to be used in between each parameter in the String..
`<T extends UrlEncodedMetadataValues> T`	`withMetadataFilter(MetadataFilter filter)`
`<T extends UrlEncodedMetadataValues> T`	`withQuerySeparator(java.lang.String s)`

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

Methods inherited from interface com.adaptris.core.Service
doService

Field Detail
- AMPERSAND
```
protected static final java.lang.String AMPERSAND
```
  See Also:
  
  Constant Field Values

Constructor Detail
- UrlEncodedMetadataValues
```
public UrlEncodedMetadataValues()
```

Method Detail

prepare
```
public void prepare()
             throws CoreException
```
Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

initService
```
protected void initService()
                    throws CoreException
```
Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService
```
protected void closeService()
```
Specified by:

closeService in class ServiceImp

getMetadataFilter

public MetadataFilter getMetadataFilter()

setMetadataFilter

public void setMetadataFilter(MetadataFilter metadataFilter)

getSeparator

public java.lang.String getSeparator()

Returns:: the querySeparator

setSeparator
```
public void setSeparator(java.lang.String s)
```
Set the separator to be used in between each parameter in the String..
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 / "/" / "?" )
 
 
```
Parameters:

s - the separator to set, defaults to null which indicates '&'.

separator

protected java.lang.String separator()

buildEncodedString

protected java.lang.String buildEncodedString(AdaptrisMessage msg)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

withMetadataFilter

public <T extends UrlEncodedMetadataValues> T withMetadataFilter(MetadataFilter filter)

withQuerySeparator

public <T extends UrlEncodedMetadataValues> T withQuerySeparator(java.lang.String s)