com.vmware.vapi.protocol

Interface RequestProcessor

All Known Implementing Classes:

JsonOAuthProcessor, JsonSessionProcessor, JsonUserPassProcessor, SecurityContextProcessor

public interface RequestProcessor

Implementations of this interface might be attached to client ApiProvider implementations as request post-processors or to the server ApiProvider implementations as request pre-processors.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequestProcessor.Request This class represents a vAPI request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SECURITY_CONTEXT_KEY
static java.lang.String	SECURITY_PROC_METADATA_KEY This key is used to transfer the authentication results to the authentication handlers using the metadata parameter.
static java.lang.String	UTF8_CHARSET

Method Summary

Modifier and Type	Method and Description
byte[]	process(byte[] requestBytes, java.util.Map<java.lang.String,java.lang.Object> metadata, RequestProcessor.Request request) Processes and possibly modifies the provided request byte array

Field Detail

UTF8_CHARSET

static final java.lang.String UTF8_CHARSET

See Also:

Constant Field Values

SECURITY_CONTEXT_KEY

static final java.lang.String SECURITY_CONTEXT_KEY

See Also:

Constant Field Values

SECURITY_PROC_METADATA_KEY

static final java.lang.String SECURITY_PROC_METADATA_KEY

This key is used to transfer the authentication results to the authentication handlers using the metadata parameter. The object corresponding to the key is expected to be a Map with String key and Object value. Content of the map is authentication handler specific.

See Also:

Constant Field Values

Method Detail

process

byte[] process(byte[] requestBytes,
               java.util.Map<java.lang.String,java.lang.Object> metadata,
               RequestProcessor.Request request)

Processes and possibly modifies the provided request byte array

Parameters:

requestBytes - must not be null. If text is passed as it MUST be UTF-8 encoded.

metadata - provides additional metadata to the processor that will be passed to the rest of the processor chain. Must not be null. The content under the SECURITY_PROC_METADATA_KEY key will be put in the request's ExecutionContext.SecurityContext under the same key i.e. will be accessible by the authentication handlers.

request - the vapi request structure. Must not be null.

Returns:

the result of the processor. Must not be null. If text is returned it MUST be UTF-8 encoded.