com.hyperion.css
Interface CSSAPIExtnIF

public interface CSSAPIExtnIF

CSSAPIIF extension iterface created to shuffle between delegated admin behavior of API and the original behaviour. This interface will mandate the methods that are the touch points to implement the differing behaviour of the API in delagated verus non-delegated mode.

Author:

Arokiaraj Joseph

Method Summary

CSSDelegatedListIF[]	getDelegatedListForPrincipal(CSSPrincipalIF principal) Determine the delegated list for the provider if delegated admin mode is enabled.
CSSGroupIF[]	getGroups(java.util.Map context, CSSPrincipalIF principal, GroupSearchFilter groupSrchFilter, CSSProviderIF provider, CSSDelegatedListIF[] delegatedList) Get the Groups matching the group search filter.
CSSGroupIF[]	getGroups(java.util.Map context, CSSPrincipalIF principal, java.lang.String groupName, CSSProviderIF provider, CSSDelegatedListIF[] delegatedList) Get the Groups matching the groupName filter.
CSSUserIF[]	getUsers(java.util.Map context, CSSPrincipalIF principal, java.lang.String userName, CSSProviderIF provider, CSSDelegatedListIF[] delegatedList) Get the Users matching the userName filter.
CSSUserIF[]	getUsers(java.util.Map context, CSSPrincipalIF principal, UserSearchFilter userSrchFilter, CSSProviderIF provider, CSSDelegatedListIF[] delegatedList) Get the Users matching the user search filter.

Method Detail

getDelegatedListForPrincipal

CSSDelegatedListIF[] getDelegatedListForPrincipal(CSSPrincipalIF principal)
                                                  throws CSSIllegalArgumentException,
                                                         CSSException

Determine the delegated list for the provider if delegated admin mode is enabled.

Parameters:

principal -

Returns:

Throws:

CSSIllegalArgumentException

CSSException

getGroups

CSSGroupIF[] getGroups(java.util.Map context,
                       CSSPrincipalIF principal,
                       java.lang.String groupName,
                       CSSProviderIF provider,
                       CSSDelegatedListIF[] delegatedList)
                       throws CSSCommunicationException,
                              CSSException

Get the Groups matching the groupName filter. If delegated admin mode is enabled, then the result will be filtered with what the user can see.

Parameters:

context -

principal - - logged-in user

groupName -

provider -

delegatedList -

Returns:

Throws:

CSSCommunicationException

CSSException

getUsers

CSSUserIF[] getUsers(java.util.Map context,
                     CSSPrincipalIF principal,
                     java.lang.String userName,
                     CSSProviderIF provider,
                     CSSDelegatedListIF[] delegatedList)
                     throws CSSCommunicationException,
                            CSSException

Get the Users matching the userName filter. If delegated admin mode is enabled, then the result will be filtered with what the user can see.

Parameters:

context -

principal - - logged-in user

userName -

provider -

delegatedList -

Returns:

Throws:

CSSCommunicationException

CSSException

getUsers

CSSUserIF[] getUsers(java.util.Map context,
                     CSSPrincipalIF principal,
                     UserSearchFilter userSrchFilter,
                     CSSProviderIF provider,
                     CSSDelegatedListIF[] delegatedList)
                     throws CSSCommunicationException,
                            CSSException

Get the Users matching the user search filter. The user search filter encapsultes the user attributes like USERNAME,FIRSTNAME,LASTNAME Etc and the values corresponding to these. Hence the search can be based on any one of these attributes.If delegated admin mode is enabled, then the result will be filtered with what the user can see.

Parameters:

context -

principal - - logged-in user

userSrchFilter -

provider -

delegatedList -

Returns:

Throws:

CSSCommunicationException

CSSException

getGroups

CSSGroupIF[] getGroups(java.util.Map context,
                       CSSPrincipalIF principal,
                       GroupSearchFilter groupSrchFilter,
                       CSSProviderIF provider,
                       CSSDelegatedListIF[] delegatedList)
                       throws CSSCommunicationException,
                              CSSException

Get the Groups matching the group search filter. The group search filter encapsulates the group attributes like NAME, DESCRIPTION and the values corresponding to these. Hence the search can be based on any one of these attributes.If delegated admin mode is enabled, then the result will be filtered with what the user can see.

Parameters:

context -

principal - - logged-in user

groupSrchFilter -

provider -

delegatedList -

Returns:

Throws:

CSSCommunicationException

CSSException