com.metamatrix.platform.admin.apiimpl
Class MembershipAdminAPIImpl

java.lang.Object
  com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl
      com.metamatrix.platform.admin.apiimpl.MembershipAdminAPIImpl

All Implemented Interfaces:

MembershipAdminAPI, SubSystemAdminAPI, java.io.Serializable

public class MembershipAdminAPIImpl
extends SubSystemAdminAPIImpl
implements MembershipAdminAPI

See Also:

Serialized Form

Method Summary

boolean	authenticateUser(java.lang.String username, Credentials credential, java.io.Serializable trustePayload, java.lang.String applicationName) Authenticate the given user / credentials as a valid system user using the given payload and application name
java.util.List	getDomainNames()
java.util.Collection	getGroupPrincipalNames()
MultipleRequestConfirmation	getGroupPrincipals(java.util.Collection groupNames) Add the given set of principals to the given role.
java.util.Set	getGroupsForDomain(java.lang.String domainName)
static MembershipAdminAPI	getInstance()
MetaMatrixPrincipal	getUserPrincipal(java.lang.String principalName)
MultipleRequestConfirmation	getUserPrincipals(java.util.Collection userNames)

Methods inherited from class com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl

getSessionID

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MembershipAdminAPI getInstance()
                                      throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

getDomainNames

public java.util.List getDomainNames()
                              throws AuthorizationException,
                                     InvalidSessionException,
                                     MetaMatrixComponentException,
                                     MetaMatrixSecurityException

Specified by:

getDomainNames in interface MembershipAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

MetaMatrixSecurityException

getGroupsForDomain

public java.util.Set getGroupsForDomain(java.lang.String domainName)
                                 throws AuthorizationException,
                                        InvalidSessionException,
                                        MetaMatrixComponentException,
                                        MetaMatrixSecurityException

Specified by:

getGroupsForDomain in interface MembershipAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

MetaMatrixSecurityException

authenticateUser

public boolean authenticateUser(java.lang.String username,
                                Credentials credential,
                                java.io.Serializable trustePayload,
                                java.lang.String applicationName)
                         throws MetaMatrixComponentException,
                                MembershipServiceException

Authenticate the given user / credentials as a valid system user using the given payload and application name

Specified by:

authenticateUser in interface MembershipAdminAPI

Parameters:

username - - user to authenticate

credential - - credentials to use when validating user

trustedpayload - - payload to use when validating user

applicationName - - applicationName to use when validating user

Returns:

Will return either a SuccessfulAuthenticationToken or an UnsuccessfulAuthenticationToken

Throws:

MetaMatrixComponentException

MembershipServiceException

See Also:

MembershipAdminAPI.authenticateUser(java.lang.String, com.metamatrix.platform.security.api.Credentials, java.io.Serializable, java.lang.String)

getUserPrincipal

public MetaMatrixPrincipal getUserPrincipal(java.lang.String principalName)
                                     throws AuthorizationException,
                                            InvalidSessionException,
                                            MetaMatrixComponentException,
                                            MetaMatrixSecurityException

Specified by:

getUserPrincipal in interface MembershipAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

MetaMatrixSecurityException

getUserPrincipals

public MultipleRequestConfirmation getUserPrincipals(java.util.Collection userNames)
                                              throws AuthorizationException,
                                                     InvalidSessionException,
                                                     MetaMatrixComponentException,
                                                     MetaMatrixSecurityException

Specified by:

getUserPrincipals in interface MembershipAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

MetaMatrixSecurityException

getGroupPrincipals

public MultipleRequestConfirmation getGroupPrincipals(java.util.Collection groupNames)
                                               throws AuthorizationException,
                                                      InvalidSessionException,
                                                      MetaMatrixComponentException,
                                                      MetaMatrixSecurityException

Add the given set of principals to the given role.

Specified by:

getGroupPrincipals in interface MembershipAdminAPI

Parameters:

principals - Set of MetaMatrixPrincipalNames to which to add.

roleName - The name of the role to which to add the principals.

Throws:

InvalidSessionException - if the administrative session is invalid

AuthorizationException - if admninistrator does not have the authority to perform the requested operation.

MetaMatrixComponentException - if this service has trouble communicating.

MetaMatrixSecurityException

getGroupPrincipalNames

public java.util.Collection getGroupPrincipalNames()
                                            throws AuthorizationException,
                                                   InvalidSessionException,
                                                   MetaMatrixComponentException,
                                                   MetaMatrixSecurityException

Specified by:

getGroupPrincipalNames in interface MembershipAdminAPI

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

MetaMatrixSecurityException