Oracle© Collaboration Suite Workspaces Web Services API Reference
10g Release 1 (10.1.2.2)

Part No. B28209-01


oracle.workspaces.ws
Interface AdministrationService


public interface AdministrationService

AdministrationService provides methods to perform administrative operations on Collaborative workspaces.

The application level role applies to a user's privileges in the Oracle Workspaces system and defines the actions a user can perform at the application level. Users granted the Application Administrator role can manage the entire Oracle Workspaces application. Some functions include granting/revoking application level roles, setting application level configuration properties and template management. Application Administrators can also perform any operation in any workspace; they can proxy as workspace administrators for any workspace.

The environment property "oracle.workspaces.ws.administrationEnabled" must be set to true.
The Axis specific code snippet given below indicates how to grant application roles.

  // Invoke an instance of administration service locator and get a handle to administration service.
  AdministrationServiceServiceLocator adssl = new AdministrationServiceServiceLocator();
  AdministrationService administrationService = adssl.getAdministrationService();
  // Set the array of roles to be granted.
  String[] appAndCreatorRoles = new String[]{"APPLICATION_ADMINS_ROLE","WORKSPACE_CREATORS_ROLE"};
  // Create a new user object supplying user's nickname.
  User u1 = new User();
  u1.setNickname("scott");
  Member m1 = new Member().
  m1.setUser(u1); 
  m1.setMemberRoleType(appAndCreatorRoles);
  // invoke method to grant the application roles
  administrationService.grantApplicationRole(m1);
 

Method Summary
 void assignOwnerToWorkspace(java.lang.String wspcId, java.lang.String userNickname)
          Assign an owner to an unowned workspace If the owner of a workspace is deleted from OID, the workspace becomes an unowned (orphaned) workspace and a workspace administrator can assign a user as the new owner of the workspace.
 Member[] getApplicationRoles(java.lang.String[] users)
          Get the application roles for the given users - A list of user nicknames is passed for getting the details of users.
 ApplicationProperties getCwApplicationProperties()
          Returns all CW application properties with their current values - Note some of the values for application properties can be null initially.
 void grantApplicationRole(Member member)
          Grant application role to a user - Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE;
 WorkspaceSummary[] listAllWorkspaces(java.lang.String[] attrRequest)
          List all workspaces the admin user has access to.
 WorkspaceRecoveryInfoItem[] listAllWorkspacesRecoveryInfo()
          Returns information about all workspaces on which manual recovery needs to be run
 FailedOperationInfoItem[] listFailedSystemOperationInfo()
          List the information of the failed system operations
 WorkspaceSummary[] listOrphanedWorkspaces(java.lang.String[] attrRequest)
          List all the orphaned workspaces A workspace without an owner is an unowned /orphaned workspace.
 Member[] listUsersWithRole(java.lang.String role)
          List all the users with the given application role Valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE
 void recoverWorkspace(java.lang.String workspaceUid, boolean force)
          Recover a workspace
 void revertCwApplicationPropertiesToDefault()
          Reverts the values of the CW application properties to their defaults
 void revokeApplicationRole(Member member)
          Revoke application role from a user - Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE
 void setCwApplicationProperties(ApplicationProperties applicationProperties)
          Store the values of the CW application properties
 void setSystemAdministratorMode(boolean sysAdminMode)
          Set the system administrator mode to true to enable application administrators access to other workspaces of which they are not members by proxy.
 void updateApplicationRoles(Member[] members, java.lang.String[] operations)
          Grant/Revoke application roles to a list of users Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE;

 

Method Detail

grantApplicationRole

public void grantApplicationRole(Member member)
                          throws CwWSException
Grant application role to a user - Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE;
Parameters:
member - - Encapsulates the application role to be granted and the user
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the object passed is null/invalid.

revokeApplicationRole

public void revokeApplicationRole(Member member)
                           throws CwWSException
Revoke application role from a user - Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE
Parameters:
member - - Encapsulates the application role to be revoked and the user
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the object passed is null/invalid.

getApplicationRoles

public Member[] getApplicationRoles(java.lang.String[] users)
                             throws CwWSException
Get the application roles for the given users - A list of user nicknames is passed for getting the details of users.
Parameters:
users - - users whose application roles are to be obtained.
Returns:
Member[] - list of member beans containing details asked for.
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the object passed is null/invalid.

listUsersWithRole

public Member[] listUsersWithRole(java.lang.String role)
                           throws CwWSException
List all the users with the given application role Valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE
Parameters:
role - - APPLICATION_ADMINS_ROLE or WORKSPACE_CREATORS_ROLE
Returns:
Member[] - information of users with the given application role
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the object passed is null/invalid.

listFailedSystemOperationInfo

public FailedOperationInfoItem[] listFailedSystemOperationInfo()
                                                        throws CwWSException
List the information of the failed system operations
Returns:
FailedOperationInfoItem[]
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

recoverWorkspace

public void recoverWorkspace(java.lang.String workspaceUid,
                             boolean force)
                      throws CwWSException
Recover a workspace
Parameters:
workspaceUid - - UID of the workspace to be recovered
force - - if true, errors will be ignored
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or if recovery fails or the object passed is null/invalid.

listAllWorkspacesRecoveryInfo

public WorkspaceRecoveryInfoItem[] listAllWorkspacesRecoveryInfo()
                                                          throws CwWSException
Returns information about all workspaces on which manual recovery needs to be run
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

getCwApplicationProperties

public ApplicationProperties getCwApplicationProperties()
                                                 throws CwWSException
Returns all CW application properties with their current values - Note some of the values for application properties can be null initially.
Returns:
ApplicationProperties - object with application properties
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

setCwApplicationProperties

public void setCwApplicationProperties(ApplicationProperties applicationProperties)
                                throws CwWSException
Store the values of the CW application properties
Parameters:
applicationProperties - - object containing application properties and their values
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the object passed is null.

revertCwApplicationPropertiesToDefault

public void revertCwApplicationPropertiesToDefault()
                                            throws CwWSException
Reverts the values of the CW application properties to their defaults
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

listOrphanedWorkspaces

public WorkspaceSummary[] listOrphanedWorkspaces(java.lang.String[] attrRequest)
                                          throws CwWSException
List all the orphaned workspaces A workspace without an owner is an unowned /orphaned workspace.
Parameters:
attrRequest - - Array representing the properties that the client is interested in retrieving - extra attributes which can be requested for include DEFAULT_MEMBER_ROLE_TYPE, MEMBERSHIP_NOTIFICATION_OPTION, WORKSPACE_PATH, WELCOME_MESSAGE and WORKSPACE_TEMPLATE_NAME
Returns:
WorkspaceSummary[] - Represents a summary of a workspace.
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

assignOwnerToWorkspace

public void assignOwnerToWorkspace(java.lang.String wspcId,
                                   java.lang.String userNickname)
                            throws CwWSException
Assign an owner to an unowned workspace If the owner of a workspace is deleted from OID, the workspace becomes an unowned (orphaned) workspace and a workspace administrator can assign a user as the new owner of the workspace.
Parameters:
wspcId - - workspace UID of orphaned workspace
userNickname - - the user who will be made owner of workspace
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or the objects passed are null/invalid.

listAllWorkspaces

public WorkspaceSummary[] listAllWorkspaces(java.lang.String[] attrRequest)
                                     throws CwWSException
List all workspaces the admin user has access to.
Parameters:
attrRequest - - Array representing the properties that the client is interested in retrieving - extra attributes which can be requested for include DEFAULT_MEMBER_ROLE_TYPE, MEMBERSHIP_NOTIFICATION_OPTION, WORKSPACE_PATH, WELCOME_MESSAGE and WORKSPACE_TEMPLATE_NAME
Returns:
WorkspaceSummary[] - Represents a summary of a workspace.
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

updateApplicationRoles

public void updateApplicationRoles(Member[] members,
                                   java.lang.String[] operations)
                            throws CwWSException
Grant/Revoke application roles to a list of users Note the client needs to populate only User nickname in the User object contained in Member; valid values for application roles are : WORKSPACE_CREATORS_ROLE and APPLICATION_ADMINS_ROLE;
Parameters:
members - - Encapsulates the application role to be updated and the user
operations - - the operation to be performed - possible values are GRANT and REVOKE
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or objects passed are null/invalid.

setSystemAdministratorMode

public void setSystemAdministratorMode(boolean sysAdminMode)
                                throws CwWSException
Set the system administrator mode to true to enable application administrators access to other workspaces of which they are not members by proxy. Set this mode to false to disable this ability.
Parameters:
sysAdminMode -
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action.

Copyright © 2001, 2006, Oracle. All rights reserved.