com.ibm.portal.resolver.operations
Interface UnsafeOperationFactory

All Superinterfaces:

OperationFactory

public interface UnsafeOperationFactory
extends OperationFactory

Factory for unsafe operations. Unsafe operations are operations which potentially modify server-side state. Unsafe operations are supposed to be triggered via HTTP POST, PUT, and DELETE.

Unsafe operation factories can be registered using the extension point UnsafeOperationFactory.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 for unsafe operations.

Method Summary

UnsafeOperation

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 for unsafe operations.

Method Detail

newOperation

UnsafeOperation 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 is supposed to return a UnsafeOperation representing a operation which potentially modifies server-side state.

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 /form parameters. Must not be null.

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

Returns:

An UnsafeOperation object. Never null.

Throws:

CannotCreateOperationException