org.jboss.as.domain.management.plugin

Interface AuthorizationPlugIn

All Known Implementing Classes:

AbstractPlugIn

public interface AuthorizationPlugIn

Interface to be implemented by a plug-in providing role information used for authorization decisions. Plug-Ins can also optionally implement either the PlugInConfigurationSupport or PlugInLifecycleSupport interfaces to be provided with configuration and a shared state map and optionally to receive a notification once the authentication process has completed.

Author:

Darran Lofthouse

Method Summary

Modifier and Type	Method and Description
String[]	loadRoles(String userName, String realm) Load and return a list of the roles for the given username and realm.

Method Detail

loadRoles

String[] loadRoles(String userName,
                   String realm)
            throws IOException

Load and return a list of the roles for the given username and realm. The username and realm supplied here will be the same as supplied to the AuthenticationPlugIn, the reason they are supplied again is that plug-ins are not required to work together so there may be no shared state. For plug-ins working together or for when the same plug-in is used for authentication and authorization it is safe to assume that this method is being called for the same user.

Parameters:

userName - - The username supplied by the user.

realm - - Either the realm supplied by the user or the name of the realm this plug-in is executing within.

Returns:

A list of the users roles.

Throws:

IOException - - If an error occurs loading the roles or if the identity can not be found.