com.ibm.portal.resolver.operations
Interface SafeOperationFactory

All Superinterfaces:

OperationFactory

public interface SafeOperationFactory
extends OperationFactory

Factory for safe operations. Safe operations are operations which do not have any side effects and which are repeatable. Safe operations are supposed to be triggered using HTTP GET requests.

Safe operation factories can be registered using the extension point SafeOperationFactory.EXTENSION_POINT_ID. Operation factory implementations must provide a 0-arg constructor.

Since:

8.0

Field Summary

static java.lang.String

EXTENSION_POINT_ID Extension point to plug in a custom factory fpr safe operations.

Method Summary

SafeOperation

newOperation(java.net.URI resourceURI, java.util.Map<java.lang.String,java.lang.String[]> operationParams, java.util.Map<java.lang.String,java.lang.String[]> requestParams, Context context) Creates a new operation for the given context.

Methods inherited from interface com.ibm.portal.resolver.operations.OperationFactory

newOperationURI, newOperationURI, newOperationURI

Field Detail

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

Extension point to plug in a custom factory fpr safe operations.

Method Detail

newOperation

SafeOperation newOperation(java.net.URI resourceURI,
                           java.util.Map<java.lang.String,java.lang.String[]> operationParams,
                           java.util.Map<java.lang.String,java.lang.String[]> requestParams,
                           Context context)
                           throws CannotCreateOperationException

Creates a new operation for the given context. This method returns a SafeOperation representing an operation which does not have any side effects but just resolves a particular resource.

Specified by:

newOperation in interface OperationFactory

Parameters:

resourceURI - The URI of the resource the operation should be applied to. May be null.

operationParams - The parameters of the operation that were part of the operation URI. Must not be null.

requestParams - The request parameters. Must not be null.

context - The current runtime context. Must not be null.

Returns:

A SafeOperation object. Never null.

Throws:

CannotCreateOperationException