com.hcl.voltmx.middleware.api.processor

Interface IdentityHandler

public interface IdentityHandler

Handler to give access to identity user profile and attributes.

Since:

Foundry V8 SP4 FP2 (8.4.2)

Method Summary

Modifier and Type	Method and Description
String	getAccountId() Gets the account id.
Map<String,Object>	getAppAttributes() Gets the application attributes.
String	getAppId() Gets the Foundry application id.
String	getAppName() Gets the Foundry application name.
Map<String,Object>	getSecurityAttributes() Gets the security attributes using default provider name.
Map<String,Object>	getSecurityAttributes(String providerName, boolean refresh) Gets the security attributes for the given provider name.
Map<String,Object>	getUserAttributes() Gets user attributes using default provider name.
Map<String,Object>	getUserAttributes(String providerName) Gets the user attributes for the given provider name.
String	getUserId() Gets the user id from identity user profile.
UserProfile	getUserProfile() Gets the user profile from identity user profile.
boolean	hasPermission(String resourcePath, String requestedMethod) Verifies if the given resource and method has permission.

Method Detail

getUserId

String getUserId()

Gets the user id from identity user profile.

Returns:

The user id.

hasPermission

boolean hasPermission(String resourcePath,
                      String requestedMethod)
               throws MiddlewareException

Verifies if the given resource and method has permission.

Parameters:

resourcePath - The resource path.

requestedMethod - The requested method.

Returns:

true, if the combination of resourcePath and requestMethod has permission.

Throws:

MiddlewareException

getUserProfile

UserProfile getUserProfile()

Gets the user profile from identity user profile.

Returns:

The UserProfile.

getAppId

String getAppId()

Gets the Foundry application id.

Returns:

The Foundry application id.

getUserAttributes

Map<String,Object> getUserAttributes()
                              throws MiddlewareException

Gets user attributes using default provider name.

Returns:

The user attributes.

Throws:

MiddlewareException

getUserAttributes

Map<String,Object> getUserAttributes(String providerName)
                              throws MiddlewareException

Gets the user attributes for the given provider name.

Parameters:

providerName - The identity provider name.

Returns:

The user attributes.

Throws:

MiddlewareException

getSecurityAttributes

Map<String,Object> getSecurityAttributes()
                                  throws MiddlewareException

Gets the security attributes using default provider name.

Returns:

The security attributes.

Throws:

MiddlewareException

getSecurityAttributes

Map<String,Object> getSecurityAttributes(String providerName,
                                         boolean refresh)
                                  throws MiddlewareException

Gets the security attributes for the given provider name.

Parameters:

providerName - The identity provider name.

refresh - The Refresh attribute.

Returns:

The security attributes.

Throws:

MiddlewareException

getAppAttributes

Map<String,Object> getAppAttributes()
                             throws MiddlewareException

Gets the application attributes.

Returns:

The application attributes.

Throws:

MiddlewareException

getAccountId

String getAccountId()

Gets the account id.

Returns:

The account id.

Since:

Foundry V8 SP4 FP3 (8.4.3) release

getAppName

String getAppName()
           throws MiddlewareException

Gets the Foundry application name.

Returns:

The Foundry application name.

Throws:

MiddlewareException - The MiddlewareException

Since:

Foundry V9 (9.0) release