jet.server.api.admin
Interface ResourceAliasManager

public interface ResourceAliasManager

ResourceAliasManager is used to manage resource aliases.

Since:

v8.0

Method Summary

java.util.Vector	allAssignedGroups(java.lang.String realmName, java.lang.String submitter) Retrieves all groups for whom a resource alias tree has been set.
java.util.Vector	allAssignedRoles(java.lang.String realmName, java.lang.String submitter) Retrieves all roles for whom a resource alias tree has been set.
java.util.Vector	allAssignedUsers(java.lang.String realmName, java.lang.String submitter) Retrieves all users for whom a resource alias tree has been set.
void	deleteAliasOfGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName, java.lang.String aliasPath) Deletes a specified alias node from the resource alias tree for a group.
void	deleteAliasOfRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName, java.lang.String aliasPath) Deletes a specified alias node from the resource alias tree for a role.
void	deleteAliasOfUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName, java.lang.String aliasPath) Deletes a specified alias node from the resource alias tree for a user.
java.util.Vector	getAliasesOfGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName) Gets all alias nodes in the resource alias tree for a specified group.
java.util.Vector	getAliasesOfRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName) Gets all alias nodes in the resource alias tree for a specified role.
java.util.Vector	getAliasesOfUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName) Gets all alias nodes in the resource alias tree for a specified user.
java.lang.String	getAllResource(java.lang.String realmName, java.lang.String submitter) Deprecated. #getInputStreamForAll(String, String)
java.lang.String	getAllResource(java.lang.String realmName, java.lang.String submitter, java.util.Locale locale) Gets the name of an xml file which contains the names of all resources in the server resource tree.
java.io.InputStream	getInputStream(java.lang.String realmName, java.lang.String submitter) Gets the input stream of the resource alias tree XML which contains the names of all resources in the server resource tree.
java.io.InputStream	getInputStreamForGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName) Gets the input stream of the resource alias tree for a group.
java.io.InputStream	getInputStreamForRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName) Gets the input stream of the resource alias tree for a role.
java.io.InputStream	getInputStreamForUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName) Gets the input stream of the resource alias tree for a user
boolean	hasAliasOfGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName) Checks whether a resource alias tree has been set for the group
boolean	hasAliasOfRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName) Checks whether a resource alias tree has been set for the role
boolean	hasAliasOfUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName) Checks whether a resource alias tree has been set for the user
boolean	hiddenSubaliasGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName, java.lang.String aliasPath) Checks whether an alias of a group is hidden.
boolean	hiddenSubaliasRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName, java.lang.String aliasPath) Checks whether an alias of a role is hidden.
boolean	hiddenSubaliasUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName, java.lang.String aliasPath) Checks whether an alias of a user is hidden.
java.lang.String	refreshAliasOfGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName) Deprecated. getInputStreamForGroup(String, String, String)
java.lang.String	refreshAliasOfRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName) Deprecated. getInputStreamForRole(String, String, String)
java.lang.String	refreshAliasOfUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName) Deprecated. getInputStreamForUser(String, String, String)
java.lang.String	setAliasForGroup(java.lang.String realmName, java.lang.String submitter, java.lang.String groupName, java.lang.String aliasPath, java.lang.String reaourcePath, boolean hidden) Sets resource alias for a group.
java.lang.String	setAliasForRole(java.lang.String realmName, java.lang.String submitter, java.lang.String roleName, java.lang.String aliasPath, java.lang.String reaourcePath, boolean hidden) Sets resource alias for a role.
java.lang.String	setAliasForUser(java.lang.String realmName, java.lang.String submitter, java.lang.String userName, java.lang.String aliasPath, java.lang.String reaourcePath, boolean hidden) Sets resource alias for a user.

Method Detail

setAliasForUser

java.lang.String setAliasForUser(java.lang.String realmName,
                                 java.lang.String submitter,
                                 java.lang.String userName,
                                 java.lang.String aliasPath,
                                 java.lang.String reaourcePath,
                                 boolean hidden)

Sets resource alias for a user.

Parameters:

realmName - the realm name

submitter - the user who sets alias. Only administrator can set alias.

userName - the user who is assigned alias

aliasPath - the complete alias path in the resource tree

reaourcePath - the complete resource path that the alias is mapped to

hidden - the flag of hidden alias

Returns:

Return null if successful, otherwise return error message.

setAliasForRole

java.lang.String setAliasForRole(java.lang.String realmName,
                                 java.lang.String submitter,
                                 java.lang.String roleName,
                                 java.lang.String aliasPath,
                                 java.lang.String reaourcePath,
                                 boolean hidden)

Sets resource alias for a role.

Parameters:

realmName - the realm name

submitter - the user who set the alias, only administrator can set alias

roleName - the role who will be assigned alias

aliasPath - the complete alias path in the resource tree

reaourcePath - the complete resource path that the alias is mapped to

hidden - the flag of hidden alias

Returns:

Return null if successful, otherwise return error message.

setAliasForGroup

java.lang.String setAliasForGroup(java.lang.String realmName,
                                  java.lang.String submitter,
                                  java.lang.String groupName,
                                  java.lang.String aliasPath,
                                  java.lang.String reaourcePath,
                                  boolean hidden)

Sets resource alias for a group.

Parameters:

realmName - the realm name

submitter - the user who set the alias, only administrator can set alias

groupName - the group who will be assigned alias

aliasPath - the complete alias path int the resource tree

reaourcePath - the complete resource path that the alias is mapped to

hidden - the flag of hidden alias

Returns:

Return null if successful, otherwise return error message.

hasAliasOfUser

boolean hasAliasOfUser(java.lang.String realmName,
                       java.lang.String submitter,
                       java.lang.String userName)

Checks whether a resource alias tree has been set for the user

Parameters:

realmName - the realm name

submitter - the user who submits the check request

userName - the user name

Returns:

Returns true if a resource alias tree has been set for the user

hasAliasOfRole

boolean hasAliasOfRole(java.lang.String realmName,
                       java.lang.String submitter,
                       java.lang.String roleName)

Checks whether a resource alias tree has been set for the role

Parameters:

realmName - the realm name

submitter - the user who submits the check request

roleName - the role name

Returns:

Returns true if a resource alias tree has been set for the role

hasAliasOfGroup

boolean hasAliasOfGroup(java.lang.String realmName,
                        java.lang.String submitter,
                        java.lang.String groupName)

Checks whether a resource alias tree has been set for the group

Parameters:

realmName - the realm name

submitter - the user who submits the check request

groupName - the group name

Returns:

Returns true if a resource alias tree has been set for the role

allAssignedUsers

java.util.Vector allAssignedUsers(java.lang.String realmName,
                                  java.lang.String submitter)

Retrieves all users for whom a resource alias tree has been set.

Parameters:

realmName - the realm name

submitter - the user who submits the request

Returns:

Returns a Vector object containing user names.

allAssignedRoles

java.util.Vector allAssignedRoles(java.lang.String realmName,
                                  java.lang.String submitter)

Retrieves all roles for whom a resource alias tree has been set.

Parameters:

realmName - the realm name

submitter - the user who submits the request

Returns:

Returns a Vector object containing role names.

allAssignedGroups

java.util.Vector allAssignedGroups(java.lang.String realmName,
                                   java.lang.String submitter)

Retrieves all groups for whom a resource alias tree has been set.

Parameters:

realmName - the realm name

submitter - the user who submits the request

Returns:

Returns a Vector object containing group names.

getAliasesOfUser

java.util.Vector getAliasesOfUser(java.lang.String realmName,
                                  java.lang.String submitter,
                                  java.lang.String userName)

Gets all alias nodes in the resource alias tree for a specified user.

Parameters:

realmName - the realm name

submitter - the user who submits the request

userName - the user name

Returns:

Returns a Vector containing ResourceAlias objects

getAliasesOfRole

java.util.Vector getAliasesOfRole(java.lang.String realmName,
                                  java.lang.String submitter,
                                  java.lang.String roleName)

Gets all alias nodes in the resource alias tree for a specified role.

Parameters:

realmName - the realm name

submitter - the user who submits the request

roleName - the role name

Returns:

Return a Vector containing ResourceAlias objects

getAliasesOfGroup

java.util.Vector getAliasesOfGroup(java.lang.String realmName,
                                   java.lang.String submitter,
                                   java.lang.String groupName)

Gets all alias nodes in the resource alias tree for a specified group.

Parameters:

realmName - the realm name

submitter - the user who submits the request

groupName - the group name

Returns:

Return a Vector containing ResourceAlias objects

hiddenSubaliasUser

boolean hiddenSubaliasUser(java.lang.String realmName,
                           java.lang.String submitter,
                           java.lang.String userName,
                           java.lang.String aliasPath)

Checks whether an alias of a user is hidden.

Parameters:

realmName - the realm name

submitter - the user who submits the request

userName - the user name

aliasPath - the alias complete path

Returns:

true if hidden

hiddenSubaliasRole

boolean hiddenSubaliasRole(java.lang.String realmName,
                           java.lang.String submitter,
                           java.lang.String roleName,
                           java.lang.String aliasPath)

Checks whether an alias of a role is hidden.

Parameters:

realmName - the realm name

submitter - the user who submits the request

roleName - the role name

aliasPath - the complete alias path

Returns:

true if hidden

hiddenSubaliasGroup

boolean hiddenSubaliasGroup(java.lang.String realmName,
                            java.lang.String submitter,
                            java.lang.String groupName,
                            java.lang.String aliasPath)

Checks whether an alias of a group is hidden.

Parameters:

realmName - the realm name

submitter - the user who submits the request

groupName - the group name

aliasPath - the alias complete path

Returns:

true if hidden

deleteAliasOfUser

void deleteAliasOfUser(java.lang.String realmName,
                       java.lang.String submitter,
                       java.lang.String userName,
                       java.lang.String aliasPath)

Deletes a specified alias node from the resource alias tree for a user.

Parameters:

realmName - the realm name

submitter - the user who submits the request

userName - the user name

aliasPath - the complete alias path

deleteAliasOfRole

void deleteAliasOfRole(java.lang.String realmName,
                       java.lang.String submitter,
                       java.lang.String roleName,
                       java.lang.String aliasPath)

Deletes a specified alias node from the resource alias tree for a role.

Parameters:

realmName - the realm name

submitter - the user who submits the request

roleName - the role name

aliasPath - the alias complete path

deleteAliasOfGroup

void deleteAliasOfGroup(java.lang.String realmName,
                        java.lang.String submitter,
                        java.lang.String groupName,
                        java.lang.String aliasPath)

Deletes a specified alias node from the resource alias tree for a group.

Parameters:

realmName - the realm name

submitter - the user who submits the request

groupName - the group name

aliasPath - the alias complete path

refreshAliasOfUser

java.lang.String refreshAliasOfUser(java.lang.String realmName,
                                    java.lang.String submitter,
                                    java.lang.String userName)

Deprecated. getInputStreamForUser(String, String, String)

Refreshes the resource alias tree for a user

Parameters:

realmName - the realm name

submitter - the user who submits the request

userName - the user name

Returns:

the name of an xml file

getInputStreamForUser

java.io.InputStream getInputStreamForUser(java.lang.String realmName,
                                          java.lang.String submitter,
                                          java.lang.String userName)

Gets the input stream of the resource alias tree for a user

Parameters:

realmName - the realm name

submitter - the user who submits the request

userName - the user name

Returns:

the input stream of an XML text

refreshAliasOfRole

java.lang.String refreshAliasOfRole(java.lang.String realmName,
                                    java.lang.String submitter,
                                    java.lang.String roleName)

Deprecated. getInputStreamForRole(String, String, String)

Refreshes the resource alias tree for a role.

Parameters:

realmName - the realm name

submitter - the user who submits the request

roleName - the role name

Returns:

the name of an xml file

getInputStreamForRole

java.io.InputStream getInputStreamForRole(java.lang.String realmName,
                                          java.lang.String submitter,
                                          java.lang.String roleName)

Gets the input stream of the resource alias tree for a role.

Parameters:

realmName - the realm name

submitter - the user who submits the request

roleName - the role name

Returns:

the input stream of an XML text

refreshAliasOfGroup

java.lang.String refreshAliasOfGroup(java.lang.String realmName,
                                     java.lang.String submitter,
                                     java.lang.String groupName)

Deprecated. getInputStreamForGroup(String, String, String)

Refreshes the resource alias tree for a group.

Parameters:

realmName - the realm name

submitter - the user who submits the request

groupName - the group name

Returns:

the name of an xml file

getInputStreamForGroup

java.io.InputStream getInputStreamForGroup(java.lang.String realmName,
                                           java.lang.String submitter,
                                           java.lang.String groupName)

Gets the input stream of the resource alias tree for a group.

Parameters:

realmName - the realm name

submitter - the user who submits the request

groupName - the group name

Returns:

the input stream of an XML text

getAllResource

java.lang.String getAllResource(java.lang.String realmName,
                                java.lang.String submitter)

Deprecated. #getInputStreamForAll(String, String)

Gets the name of an xml file which contains the names of all resources in the server resource tree.

Parameters:

realmName - the realm name

submitter - the user who submits the request

Returns:

the name of an xml file

getAllResource

java.lang.String getAllResource(java.lang.String realmName,
                                java.lang.String submitter,
                                java.util.Locale locale)

Gets the name of an xml file which contains the names of all resources in the server resource tree.

Parameters:

realmName - the realm name

submitter - the user who submits the request

locale - the locale

Returns:

the name of an xml file

getInputStream

java.io.InputStream getInputStream(java.lang.String realmName,
                                   java.lang.String submitter)

Gets the input stream of the resource alias tree XML which contains the names of all resources in the server resource tree.

Parameters:

realmName - the realm name

submitter - the user who submits the request

Returns:

the input stream of an XML text