com.ibm.mfp.server.security.external.checks

Interface AuthorizationResponse

public interface AuthorizationResponse

Aggregates authorization responses from multiple security checks. Challenge eliminates the success (scopes), and failure eliminates success and challenge

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorizationResponse.ResponseType

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationResponse	addChallenge(java.lang.String securityCheckName, java.util.Map challenge) Add a challenge.
AuthorizationResponse	addFailure(java.lang.String securityCheckName, java.util.Map failureData) Add a failure
AuthorizationResponse	addSuccess(java.util.Set scope, long expiresAt, java.lang.String securityCheckName) Add success scope and its expiration
AuthorizationResponse	addSuccess(java.util.Set scope, long expiresAt, java.lang.String securityCheckName, java.lang.String key, java.lang.Object value) Add success scope, its expiration, and a field for the success object that will be delivered to the challenge handler.
AuthorizationResponse.ResponseType	getType() Get the current type of the response

Method Detail

getType

AuthorizationResponse.ResponseType getType()

Get the current type of the response

Returns:

SUCCESS, CHALLENGE, or FAILURE

addSuccess

AuthorizationResponse addSuccess(java.util.Set scope,
                               long expiresAt,
                               java.lang.String securityCheckName)

Add success scope and its expiration

Parameters:

scope - the scope granted by the security check

expiresAt - expiration of the granted scope

securityCheckName - name of the security check for the success data object

Returns:

the same response object

addSuccess

AuthorizationResponse addSuccess(java.util.Set scope,
                               long expiresAt,
                               java.lang.String securityCheckName,
                               java.lang.String key,
                               java.lang.Object value)

Add success scope, its expiration, and a field for the success object that will be delivered to the challenge handler. This method can be called repeatedly, and the fields will be added to the success data object.

Parameters:

scope - the scope granted by the security check

expiresAt - expiration of the granted scope

securityCheckName - name of the security check for the success data object

key - the field name in the success data object

value - the field value

Returns:

the same response object

addChallenge

AuthorizationResponse addChallenge(java.lang.String securityCheckName,
                                 java.util.Map challenge)

Add a challenge.

Parameters:

securityCheckName - the name of the challenging security check

challenge - the challenge object

Returns:

the same response object

addFailure

AuthorizationResponse addFailure(java.lang.String securityCheckName,
                               java.util.Map failureData)

Add a failure

Parameters:

securityCheckName - the name of the failed security check

failureData - the failure object

Returns:

the same response object