com.vmware.vapi.dsig.json

Class SecurityContextProcessor

java.lang.Object

com.vmware.vapi.dsig.json.SecurityContextProcessor

All Implemented Interfaces:

RequestProcessor

Direct Known Subclasses:

JsonOAuthProcessor, JsonSessionProcessor, JsonUserPassProcessor

public abstract class SecurityContextProcessor
extends java.lang.Object
implements RequestProcessor

This is an abstract processor that inserts the appropriate security context data into the request. Is is an extension point for third party authentication schemes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.protocol.RequestProcessor

RequestProcessor.Request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEME_ID_KEY

Fields inherited from interface com.vmware.vapi.protocol.RequestProcessor

SECURITY_CONTEXT_KEY, SECURITY_PROC_METADATA_KEY, UTF8_CHARSET

Constructor Summary

Constructors

Constructor and Description
SecurityContextProcessor()

Method Summary

Modifier and Type	Method and Description
abstract java.util.Map<java.lang.String,java.lang.Object>	getSecurityContextProperties(ExecutionContext.SecurityContext ctx)
abstract boolean	isSchemeSupported(java.lang.String requestedScheme)
byte[]	process(byte[] request, java.util.Map<java.lang.String,java.lang.Object> metadata, RequestProcessor.Request vapiRequest) Processes and possibly modifies the provided request byte array

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_ID_KEY

public static final java.lang.String SCHEME_ID_KEY

See Also:

Constant Field Values

Constructor Detail

SecurityContextProcessor

public SecurityContextProcessor()

Method Detail

process

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

Description copied from interface: RequestProcessor

Processes and possibly modifies the provided request byte array

Specified by:

process in interface RequestProcessor

Parameters:

request - 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 RequestProcessor.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.

vapiRequest - 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.

isSchemeSupported

public abstract boolean isSchemeSupported(java.lang.String requestedScheme)

Parameters:

requestedScheme - the authentication scheme that is used with the current security context

Returns:

true if the processor is able to handle the requested scheme, false otherwise

getSecurityContextProperties

public abstract java.util.Map<java.lang.String,java.lang.Object> getSecurityContextProperties(ExecutionContext.SecurityContext ctx)

Parameters:

ctx - the current security context. cannot be null.

Returns:

map of the data that should be serialized as part of the security context. The security context is permitted to contain only Maps, Arrays and Strings. cannot be null.