|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MembershipServiceInterface
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_PASSWORD
|
static java.lang.String |
ADMIN_USERNAME
|
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
|
Fields inherited from interface com.metamatrix.platform.service.api.ServiceInterface |
---|
WAIT_TO_DIE_TIME |
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 |
getDomainNames()
|
java.util.Set |
getGroupNames()
Obtain the collection of group names. |
java.util.Set |
getGroupsForDomain(java.lang.String domainName)
|
java.util.Set |
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.platform.service.api.ServiceInterface |
---|
checkState, die, dieNow, getCurrentState, getHostname, getID, getInitException, getProcessName, getProperties, getQueueStatistics, getQueueStatistics, getServiceType, getStartTime, getStateChangeTime, init, isAlive, setInitException, updateState |
Field Detail |
---|
static final java.lang.String NAME
static final java.lang.String DOMAIN_ORDER
static final java.lang.String DOMAIN_NAME
static final java.lang.String DEFAULT_ADMIN_USERNAME
static final java.lang.String DEFAULT_WSDL_USERNAME
static final java.lang.String ADMIN_PASSWORD
static final java.lang.String ADMIN_USERNAME
static final java.lang.String DOMAIN_ACTIVE
static final java.lang.String SECURITY_ENABLED
static final java.lang.String DOMAIN_PROPERTIES
Method Detail |
---|
AuthenticationToken authenticateUser(java.lang.String username, Credentials credential, java.io.Serializable trustePayload, java.lang.String applicationName) throws MembershipServiceException
username
- the username that is to be authenticatedcredential
- the credential provided by the user that is to be used
to authenticate the user for the principal nametrustePayload
- applicationName
- the name of the application for which the user
is authenticating
MetaMatrixSecurityException
- if there is an error within this
service or during communicating with the underlying service provider
MembershipServiceException
MetaMatrixPrincipal getPrincipal(MetaMatrixPrincipalName principal) throws MembershipServiceException, InvalidPrincipalException
MembershipServiceException
InvalidPrincipalException
java.util.Set getGroupsForUser(java.lang.String username) throws MembershipServiceException, InvalidPrincipalException
MembershipServiceException
InvalidPrincipalException
java.util.Set getGroupNames() throws MembershipServiceException
MembershipServiceException
java.util.List getDomainNames() throws MembershipServiceException
MembershipServiceException
java.util.Set getGroupsForDomain(java.lang.String domainName) throws MembershipServiceException
MembershipServiceException
boolean isSuperUser(java.lang.String username) throws MembershipServiceException
MembershipServiceException
boolean isSecurityEnabled() throws MembershipServiceException
MembershipServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |