com.ibm.portal.resolver.data
Interface DataSinkFactoryEx

All Known Subinterfaces:

CreateDataSinkFactoryEx, DeleteDataSinkFactoryEx, UpdateDataSinkFactoryEx

public interface DataSinkFactoryEx

Tagging interface for data sink factory.

A data sink factory is registered in the plugin.xml of the providing extension as a serviceHandler

.

Since:

6.0.1.1

See Also:

CreateDataSinkFactoryEx, UpdateDataSinkFactoryEx, DeleteDataSinkFactoryEx, CORDataSinkFactoryEx#SINGLETON, PocServiceHome.getDataSinkFactory()

Note:

This interface is designed to be implemented by clients.

Field Summary

static java.lang.String	DEFAULT_MODE Default value for the mode that data sinks are requested with using the data sink factory
static java.util.Map<java.lang.String,java.lang.String[]>	EMPTY_PARAMETERS The empty parameters map, unmodifiable

Method Summary

DataSink

newSink(java.net.URI uri, java.lang.String mode, java.util.Map<java.lang.String,java.lang.String[]> params, java.lang.String mimeType, Context ctx) Generates a data sink that is able to handle an input stream of data and produces an output stream as a response.

Field Detail

EMPTY_PARAMETERS

static final java.util.Map<java.lang.String,java.lang.String[]> EMPTY_PARAMETERS

The empty parameters map, unmodifiable

Since:

8.0

DEFAULT_MODE

static final java.lang.String DEFAULT_MODE

Default value for the mode that data sinks are requested with using the data sink factory

Since:

8.0

See Also:

Constant Field Values

Method Detail

newSink

DataSink newSink(java.net.URI uri,
                 java.lang.String mode,
                 java.util.Map<java.lang.String,java.lang.String[]> params,
                 java.lang.String mimeType,
                 Context ctx)
                 throws java.io.IOException

Generates a data sink that is able to handle an input stream of data and produces an output stream as a response.

Parameters:

uri - POCURI of the addressed resource, must not be null and must contain a valid scheme identifier

mode - mode constant

params - unmodifiable parameters map (String -> String[]), may be empty but not null

mimeType - content type of the input data

ctx - COR context, not null

Returns:

an implementation of a DataSink. May be null in which case the implementation indicates that the URI will not be processed.

Throws:

java.io.IOException - - if the data sink cannot be created