|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SecurityAdministrator
Administers user and role security for the Flux engine. Through this interface, permissions are defined and assigned to roles and users. Certain permissions are required to execute certain tasks in a Flux engine.
This interface also manages user information such as username, password, email addresses, and other contact information. A default administrator account called "admin" is always guaranteed to exist. This default administrator account has a default password of "admin" and has administrator privileges. This default account cannot be deleted or renamed. Two default roles called "Administrator" and "Flow Chart Master" are always guaranteed to exist. The default administrator account is always in the default Administrator role, which is allowed to perform any action. The default Flow Chart Master role allows a user to perform any operation on any flow chart but is prevented from performing typical administrative functions, such as managing users. This interface is active only if the Flux engine is a secure engine. Furthermore, some methods on this interface require administrator privileges. They are marked accordingly.
Method Summary | |
---|---|
Role |
getRole(java.lang.String rolename)
Returns the specified role. |
java.util.SortedSet<Role> |
getRoles()
Returns all roles sorted by role name. |
User |
getUser(java.lang.String username)
Returns the specified user. |
UserIterator |
getUsers()
Returns all users sorted by username. |
UserIterator |
getUsers(java.lang.String userPattern)
Returns all users that match the specified pattern, sorted by username. |
void |
putRole(Role role)
Adds or updates a role. |
void |
putUser(User user)
Adds or updates a user in the cluster. |
boolean |
removeRole(java.lang.String rolename)
Deletes the specified role. |
boolean |
removeUser(java.lang.String username)
Deletes the specified user from the Flux engine. |
boolean |
renameRole(java.lang.String oldRolename,
java.lang.String newRolename)
Renames an existing role. |
long |
sizeUsers()
Returns the number of users in the Flux engine. |
Method Detail |
---|
Role getRole(java.lang.String rolename) throws EngineException
rolename
- The name of the role to retrieve.
EngineException
- If rolename is null or empty, the caller does not
have administrator privileges, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.java.util.SortedSet<Role> getRoles() throws EngineException
EngineException
- If the caller does not have administrator
privileges or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.User getUser(java.lang.String username) throws EngineException
username
- The user to retrieve.
EngineException
- If username is null or empty, the caller does not
have administrator privileges, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.UserIterator getUsers() throws EngineException
EngineException
- If the caller does not have administrator
privileges or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.UserIterator getUsers(java.lang.String userPattern) throws EngineException
userPattern
- A description of users to find using wildcard
characters.
EngineException
- If userPattern is null or empty, the caller does
not have administrator privileges, or if a system
error occurs.
EngineCommunicationException
- If a networking error occurs.void putRole(Role role) throws EngineException
role
- The role to be added or updated.
EngineException
- If role is null, the caller does not have
administrator privileges, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.void putUser(User user) throws EngineException
user
- The user to be added or updated.
EngineException
- If user is null, the caller does not have
administrator privileges, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.boolean removeRole(java.lang.String rolename) throws EngineException
rolename
- The name of the role to delete.
EngineException
- If rolename is null or empty, the caller does not
have administrator privileges, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.boolean removeUser(java.lang.String username) throws EngineException
username
- The name of the user to delete.
EngineException
- If the user is referenced in a run-as-user flow
chart property, or a run-as-user runtime
configuration property; username is null or empty;
username is "admin"; the caller does not have
administrator privileges; or a system error occurs.
EngineCommunicationException
- If a networking error occurs.boolean renameRole(java.lang.String oldRolename, java.lang.String newRolename) throws EngineException
oldRolename
- The existing role name.newRolename
- The new role name.
EngineException
- If either role name is null or empty or a system
error occurs.
EngineCommunicationException
- If a networking error occurs.long sizeUsers() throws EngineException
EngineException
- If the caller does not have administrator
privileges or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |