com.metamatrix.platform.security.api.service
Interface MembershipServiceInterface

All Superinterfaces:
ApplicationService
All Known Implementing Classes:
MembershipServiceImpl

public interface MembershipServiceInterface
extends ApplicationService

This interface represents the API to the MemberShip Service, and it defines the functionality that is accessible to clients.


Field Summary
static java.lang.String ADMIN_HOSTS
           
static java.lang.String ADMIN_PASSWORD
           
static java.lang.String ADMIN_USERNAME
           
static java.lang.String AT
           
static java.lang.String DEFAULT_ADMIN_USERNAME
           
static java.lang.String DEFAULT_WSDL_USERNAME
           
static java.lang.String DOMAIN_ACTIVE
           
static java.lang.String DOMAIN_NAME
          The environment property name for the class that is to be used for the names of the domains.
static java.lang.String DOMAIN_ORDER
          The environment property describing both the domain names and their required order of search.
static java.lang.String DOMAIN_PROPERTIES
           
static java.lang.String NAME
           
static java.lang.String SECURITY_ENABLED
           
 
Method Summary
 AuthenticationToken authenticateUser(java.lang.String username, Credentials credential, java.io.Serializable trustePayload, java.lang.String applicationName)
          Authenticate a user with the specified username and credential for use with the specified application.
 java.util.List<java.lang.String> getDomainNames()
           
 java.util.Set<java.lang.String> getGroupNames()
          Obtain the collection of group names.
 java.util.Set<java.lang.String> getGroupsForDomain(java.lang.String domainName)
           
 java.util.Set<java.lang.String> getGroupsForUser(java.lang.String username)
          Obtain the collection of groups to which this user belongs The username should be fully qualified
 MetaMatrixPrincipal getPrincipal(MetaMatrixPrincipalName principal)
          Obtain the principal object that is representative of the user with the specified username.
 boolean isSecurityEnabled()
           
 boolean isSuperUser(java.lang.String username)
           
 
Methods inherited from interface com.metamatrix.common.application.ApplicationService
initialize, start, stop
 

Field Detail

NAME

static final java.lang.String NAME
See Also:
Constant Field Values

DOMAIN_ORDER

static final java.lang.String DOMAIN_ORDER
The environment property describing both the domain names and their required order of search. Domain names are assumed to be in preferred search order and in the form "A,X,...,D" where A, X and D are domain names. This property is required (there is no default).

See Also:
Constant Field Values

DOMAIN_NAME

static final java.lang.String DOMAIN_NAME
The environment property name for the class that is to be used for the names of the domains. This property is required (there is no default).

See Also:
Constant Field Values

DEFAULT_ADMIN_USERNAME

static final java.lang.String DEFAULT_ADMIN_USERNAME
See Also:
Constant Field Values

DEFAULT_WSDL_USERNAME

static final java.lang.String DEFAULT_WSDL_USERNAME
See Also:
Constant Field Values

ADMIN_PASSWORD

static final java.lang.String ADMIN_PASSWORD
See Also:
Constant Field Values

ADMIN_USERNAME

static final java.lang.String ADMIN_USERNAME
See Also:
Constant Field Values

DOMAIN_ACTIVE

static final java.lang.String DOMAIN_ACTIVE
See Also:
Constant Field Values

ADMIN_HOSTS

static final java.lang.String ADMIN_HOSTS
See Also:
Constant Field Values

SECURITY_ENABLED

static final java.lang.String SECURITY_ENABLED
See Also:
Constant Field Values

DOMAIN_PROPERTIES

static final java.lang.String DOMAIN_PROPERTIES
See Also:
Constant Field Values

AT

static final java.lang.String AT
See Also:
Constant Field Values
Method Detail

authenticateUser

AuthenticationToken authenticateUser(java.lang.String username,
                                     Credentials credential,
                                     java.io.Serializable trustePayload,
                                     java.lang.String applicationName)
                                     throws MembershipServiceException
Authenticate a user with the specified username and credential for use with the specified application. The application name may also be used by the Membership Service to determine the appropriate authentication mechanism.

Parameters:
username - the username that is to be authenticated
credential - the credential provided by the user that is to be used to authenticate the user for the principal name
trustePayload -
applicationName - the name of the application for which the user is authenticating
Returns:
true if the specified credentials properly authenticates for the application the user with the specified username and application
Throws:
MetaMatrixSecurityException - if there is an error within this service or during communicating with the underlying service provider
MembershipServiceException

getPrincipal

MetaMatrixPrincipal getPrincipal(MetaMatrixPrincipalName principal)
                                 throws MembershipServiceException,
                                        InvalidPrincipalException
Obtain the principal object that is representative of the user with the specified username. all names should be domain qualified.

Throws:
MembershipServiceException
InvalidPrincipalException

getGroupsForUser

java.util.Set<java.lang.String> getGroupsForUser(java.lang.String username)
                                                 throws MembershipServiceException,
                                                        InvalidPrincipalException
Obtain the collection of groups to which this user belongs The username should be fully qualified

Throws:
MembershipServiceException
InvalidPrincipalException

getGroupNames

java.util.Set<java.lang.String> getGroupNames()
                                              throws MembershipServiceException
Obtain the collection of group names.

Throws:
MembershipServiceException

getDomainNames

java.util.List<java.lang.String> getDomainNames()
                                                throws MembershipServiceException
Throws:
MembershipServiceException

getGroupsForDomain

java.util.Set<java.lang.String> getGroupsForDomain(java.lang.String domainName)
                                                   throws MembershipServiceException
Throws:
MembershipServiceException

isSuperUser

boolean isSuperUser(java.lang.String username)
                    throws MembershipServiceException
Throws:
MembershipServiceException

isSecurityEnabled

boolean isSecurityEnabled()
                          throws MembershipServiceException
Throws:
MembershipServiceException


Copyright © 2009. All Rights Reserved.