com.eruces.teadmin.Administration

The Administration class manages all user, role and ACL information.

Inheritance

Inherits com.eruces.teagent.IConnection

Static Public Attributes

Type	Name	Description
final short	`ADD_ACLENTRY`	The ADD_ACLENTRY field is a container for adding an ACL entry.
final short	`UPDATE_ACLENTRY`	The UPDATE_ACLENTRY field is a container for updating an ACL entry.
final short	`REMOVE_ACLENTRY`	The REMOVE_ACLENTRY field is a container for removing an ACL entry.

Public Member Functions

Member	Description
`Administration()`	The Administration constructor is the default class constructor.
`ACLInfo getACL(String strHiddenLink)`	The getACL method retrieves a TTag's ACL.
`ACLInfo getACL(byte[] strHiddenLink)`	The getACL method retrieves a TTag's ACL.
`void updateACL(short nCode, ACLInfo acl)`	The updateACL method updates ACL information.
`PrincipalInfo addPrincipal(PrincipalInfo pal)`	The addPrincipal method adds a new principal to the system.
`void removePrincipal(PrincipalInfo pal, PrincipalInfo palRe)`	The removePrincipal method removes a principal from the system and assigns the principal's keys to another principal.
`void removePrincipal(PrincipalInfo pal)`	The removePrincipal method removes a principal from the TE system.
`void updatePrincipal(PrincipalInfo pal)`	The updatePrincipal method updates information about a principal.
`PrincipalInfo getPrincipal(PrincipalInfo info)`	The getPrincipal method gets detailed information about a specific principal.
`PrincipalInfo[] getPrincipalList()`	The getPrincipalList method gets a list of all principals (Database Edition).
`PrincipalInfo[] getPrincipalList(PList listIDs)`	The getPrincipalList method gets a list of all principals that are part of a specific list.
`PrincipalInfo[] getPrincipalList(int[] sid, long[] pid)`	The getPrincipalList method gets a list of all principals that are part of a specific list.
`PrincipalInfo[] getPrincipalList(String[] strClsName)`	The getPrincipalList method gets a list of all principals of a specific type.
`PrincipalInfo[] getPrincipalList(String[] strClsName, int nSysID)`	The getPrincipalList method gets a list of all principals of a specific type from a remote server.
`PrincipalInfo[] getPrincipalList(long nGroupID)`	The getPrincipalList method gets a list of all principals of a group.
`UserAndPasswordInfo getUserByName(String strUserName)`	The getUserByName method gets information about a user having a specific username.
`Role[] createRoles(Role role[])`	The createRoles method adds multiple new roles to the system.
`void assignRoles(PrincipalInfo pinfo, long[] roleid)`	The assignRoles method assigns existing roles to a principal.
`void removeRoles(PrincipalInfo pinfo, long[] roleid)`	The removeRole method removes a role from a specific principal.
`void removeRole(long id)`	The removeRole method removes a role having a specific ID from the system.
`Role[] getAllRoles()`	The getAllRoles method gets a list of all roles.
`Role[] getRolesOfPrincipal(PrincipalInfo p)`	The getRolesOfPrincipal method gets an array of roles assigned to a specific principal.
`Role[] getRolesOfPrincipal(PList plistRoleIDs)`	The getRolesOfPrincipal method gets an array of roles assigned to a specific principal.
`void updateRoles(Role role[])`	The updateRoles method updates multiple roles.
`Operation[] getAllOperations()`	The getAllOperations method gets a list of all user operations.
`void assignGroups(PrincipalInfo pinfo, long[] groupid)`	The assignGroups method assigns multiple groups to a principal.
`void removeGroups(PrincipalInfo pinfo, long[] groupid)`	The removeGroups method removes multiple groups from a principal.
`void addPrincipalsToGroup(long nGroupID, long[] nPrincipalIDs)`	The addPrincipalsToGroup method adds multiple existing principals to a specific group.
`void removePrincipalsFromGroup(long nGroupID, long[] nPrincipalIDs)`	The removePrincipalsFromGroup method removes multiple principals from a specific group.
`void resetPassword(String strName, String strPasswd)`	The resetPassword method resets the password of the currently logged on user.
`void emergencyCheckIn(long[] nPrincipalIDs)`	The emergencyCheckIn method allows administrative check-in of all keys checked out by a specific principal.
`int getSystemID()`	The getSystemID method gets a system ID.
`Version getVersion()`	The getVersion method gets a system's version information.

Member Function Documentation

`Administration()`

The Administration constructor is the default class constructor.

`ACLInfo getACL(String strHiddenLink)`

The getACL method retrieves a TTag's ACL.

Parameters

Parameter	Description
`strHiddenLink`	A String representing the TTag

Returns: An ACLInfo object representing the ACL.

`ACLInfo getACL(byte[] strHiddenLink)`

The getACL method retrieves a TTag's ACL.

Parameters

Parameter	Description
`strHiddenLink`	byte array of the TTag

Returns: Returns an ACLInfo object.

`void updateACL(short nCode, ACLInfo acl)`

The updateACL method updates ACL information.

Parameters

Parameter	Description
`nCode`	A short variable representing an operation code; possible values could be ADD_ACLENTRY, UPDATE_ACLENTRY, REMOVE_ACLENTRY.
`acl`	An ACLInfo object to be modified.

`PrincipalInfo addPrincipal(PrincipalInfo pal)`

The addPrincipal method adds a new principal to the system.

Parameters

Parameter	Description
`pal`	A principal object to be added

`void removePrincipal(PrincipalInfo pal, PrincipalInfo palRe)`

The removePrincipal method removes a principal from the system and assigns the principal's keys to another principal.

Parameters

Parameter	Description
`pal`	A principal object to be removed.
`palRe`	A replacement PrincipalInfo object to which the removed principal's keys will be assigned.

`void removePrincipal(PrincipalInfo pal)`

The removePrincipal method removes a principal from the TE system.

(Only for Database edition) Deprecated

Parameters

Parameter	Description
`pal`	principal object to be removed

Remark: This method can only be used for Database Edition

`void updatePrincipal(PrincipalInfo pal)`

The updatePrincipal method updates information about a principal.

Parameters

Parameter	Description
`pal`	A principal object to be updated.

`PrincipalInfo getPrincipal(PrincipalInfo info)`

The getPrincipal method gets detailed information about a specific principal.

Parameters

Parameter	Description
`info`	A principal object which principal ID should be set

Returns: Returns a PrincipalInfo object with detailed principal information.