org.eclipse.smila.processing.pipelets

Class CodecPipelet

java.lang.Object

org.eclipse.smila.processing.pipelets.CodecPipelet

All Implemented Interfaces:

Pipelet

public class CodecPipelet
extends java.lang.Object
implements Pipelet

Decodes/encodes encoded attributes into or from attachments.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CHARSET The string encoding.
static java.lang.String	DEFAULT_ATTRIBUTE_NAME Default attribute name for the attribute containing the attachments.
static java.lang.String	DEFAULT_ENCODING Default encoding.
static java.lang.String	ENCODING_BASE64 BASE64 encoding.
static java.lang.String	KEY_CONTENT key for the content of the attachment.
static java.lang.String	KEY_NAME key for the name of the attachment.
static java.lang.String	PROP_ATTRIBUTE_NAME Name of the input attribute where the encoded attachments are stored.
static java.lang.String	PROP_CODEC_NAME Name of the codec.
static java.lang.String	PROP_ENCODE If set to "true", the Pipelet encodes attachments to encoded strings in the attribute.
static java.lang.String	PROP_REMOVE_INPUT If set to 'true', the Pipelet removes the input of the operation (either attachment or attribute).
static java.util.Collection<java.lang.String>	SUPPORTED_ENCODINGS Supported encodings.

Constructor Summary

Constructors

Constructor and Description
CodecPipelet()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(AnyMap configuration) set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
protected void	decodeEntry(Blackboard blackboard, java.lang.String id, java.lang.String encodingName, AnyMap entry) Decode an entry.
protected AnyMap	encodeAttachment(Blackboard blackboard, java.lang.String id, java.lang.String encodingName, java.lang.String attachmentName) Encodes an attachment to an encoded entry in an attribute.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] recordIds) Decodes encoded strings which are stored in a sequence attribute of the record and stores them as attachments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_NAME

public static final java.lang.String KEY_NAME

key for the name of the attachment.

See Also:

Constant Field Values

KEY_CONTENT

public static final java.lang.String KEY_CONTENT

key for the content of the attachment.

See Also:

Constant Field Values

PROP_ATTRIBUTE_NAME

public static final java.lang.String PROP_ATTRIBUTE_NAME

Name of the input attribute where the encoded attachments are stored.

See Also:

Constant Field Values

CHARSET

public static final java.nio.charset.Charset CHARSET

The string encoding.

PROP_CODEC_NAME

public static final java.lang.String PROP_CODEC_NAME

Name of the codec. Currently only BASE64 is supported. (Which is also the default value.)

See Also:

Constant Field Values

PROP_ENCODE

public static final java.lang.String PROP_ENCODE

If set to "true", the Pipelet encodes attachments to encoded strings in the attribute. If set to "false", the Piplet decodes strings from the attribute to attachments. This parameter is mandatory.

See Also:

Constant Field Values

PROP_REMOVE_INPUT

public static final java.lang.String PROP_REMOVE_INPUT

If set to 'true', the Pipelet removes the input of the operation (either attachment or attribute). If set to 'false' (default), the content remains in the processed record for further processing. Default: 'false'.

See Also:

Constant Field Values

DEFAULT_ATTRIBUTE_NAME

public static final java.lang.String DEFAULT_ATTRIBUTE_NAME

Default attribute name for the attribute containing the attachments.

See Also:

Constant Field Values

ENCODING_BASE64

public static final java.lang.String ENCODING_BASE64

BASE64 encoding.

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

Default encoding.

See Also:

Constant Field Values

SUPPORTED_ENCODINGS

public static final java.util.Collection<java.lang.String> SUPPORTED_ENCODINGS

Supported encodings.

Constructor Detail

CodecPipelet

public CodecPipelet()

Method Detail

configure

public void configure(AnyMap configuration)
               throws ProcessingException

set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Specified by:

configure in interface Pipelet

Parameters:

configuration - configuration of pipelet.

Throws:

ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)

process

public java.lang.String[] process(Blackboard blackboard,
                         java.lang.String[] recordIds)
                           throws ProcessingException

Decodes encoded strings which are stored in a sequence attribute of the record and stores them as attachments. The sttribute contains a sequence of maps with keys for the "name" of the attachment and the encoded "content". The default name of the attribute is "_attachments". The attachments' names will be equal to the "name" value of the attachment entry in the sequence. Example record:

 {
   "_attachments" : [{
       "name" : "att1.txt",
       "content" : "VGhpcyBpcyB0aGUgZGVjb2RlZCBjb250ZW50Lg=="
     }, {
       "name" : "att2.pdf",
       "content" : "VGhpcyBpcyB0aGUgZGVjb2RlZCBjb250ZW50Lg=="
     }
   ]
 }
 

Specified by:

process in interface Pipelet

Parameters:

blackboard - Blackboard holding and managing the records.

recordIds - Ids of records to process.

Returns:

Ids of records to be passed into the next pipelet. By default this should be the same as the passed in recordIds unless there is a specific (businesslogic) reason not to do so.

Throws:

ProcessingException - error during processing.

encodeAttachment

protected AnyMap encodeAttachment(Blackboard blackboard,
                      java.lang.String id,
                      java.lang.String encodingName,
                      java.lang.String attachmentName)
                           throws BlackboardAccessException,
                                  java.io.IOException

Encodes an attachment to an encoded entry in an attribute.

Parameters:

blackboard - the blackboard

id - the id of the record

encodingName - the name of the encoding to use

attachmentName - the name of the attachment

Returns:

the entry containing the name and encoded content of the attachment

Throws:

BlackboardAccessException

java.io.IOException

decodeEntry

protected void decodeEntry(Blackboard blackboard,
               java.lang.String id,
               java.lang.String encodingName,
               AnyMap entry)
                    throws BlackboardAccessException

Decode an entry.

Parameters:

blackboard - The blackboard

id - the record's id

encodingName - the name of the encoding to use

entry - thh entry containing the name and encoded content

Throws:

BlackboardAccessException