com.tibco.bpm.service.connector

Class SecurityService

java.lang.Object

com.tibco.bpm.service.connector.SecurityService

All Implemented Interfaces:

SecurityService

public class SecurityService
extends java.lang.Object
implements SecurityService

Provides access to the SecurityService interfaces.

©2011 Cloud Software Group, Inc.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
com.tibco.n2.de.api.security.AuthenticateUserResponseDocument.AuthenticateUserResponse	authenticateUser(byte[] password, java.lang.String login) Authenticates a user with the given login name and password, returning a GUID with which subsequent references can be made.
com.tibco.n2.de.api.security.GetUserPrivilegesResponseDocument.GetUserPrivilegesResponse	getUserPrivileges(java.lang.String userGuid) Returns the privilege assignments for the Resource identified by the given GUID.
com.tibco.n2.de.api.security.IsActionAuthorisedResponseDocument.IsActionAuthorisedResponse	isActionAuthorised(com.tibco.n2.common.organisation.api.XmlModelEntityId scope, com.tibco.n2.common.organisation.api.XmlModelEntityId performer, com.tibco.n2.de.api.security.XmlSystemAction[] action, boolean faultOnUnauthorised) Tests whether the caller (determined by the SOAP security header) is authorised to perform the named System Action in the context of the targeted Organisational Entity.
com.tibco.n2.de.api.security.IsActionAuthorisedResponseDocument.IsActionAuthorisedResponse	isActionAuthorised(com.tibco.n2.common.organisation.api.XmlModelEntityId scope, com.tibco.n2.de.api.security.XmlSystemAction[] action, boolean faultOnUnauthorised) Tests whether the caller (determined by the SOAP security header) is authorised to perform the named System Action in the context of the targeted Organisational Entity.
com.tibco.n2.de.api.security.ListActionAuthorisedEntitiesResponseDocument.ListActionAuthorisedEntitiesResponse	listActionAuthorisedEntities(java.lang.String component, java.lang.String name) Returns a list of Entities which the caller (determined by the SOAP security header) is authorised to perform the named System Action on.
com.tibco.n2.de.api.security.ListAuthorisedOrgsResponseDocument.ListAuthorisedOrgsResponse	listAuthorisedOrgs(java.lang.String component, java.lang.String name) Returns a list of Organisation GUIDs which the caller (determined by the SOAP security header) is authorised to perform the named System Action on.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

authenticateUser

public com.tibco.n2.de.api.security.AuthenticateUserResponseDocument.AuthenticateUserResponse authenticateUser(byte[] password,
                                                                                                               java.lang.String login)
                                                                                                        throws com.tibco.n2.de.services.InternalServiceFault,
                                                                                                               com.tibco.n2.de.services.InvalidServiceRequestFault

Description copied from interface: SecurityService

Authenticates a user with the given login name and password, returning a GUID with which subsequent references can be made.

Specified by:

authenticateUser in interface SecurityService

Parameters:

password - A byte array containing base64 encoded password.

login - Login name.

Returns:

Returns AuthenticateUserResponse which contains the guid if successful.

Throws:

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

getUserPrivileges

public com.tibco.n2.de.api.security.GetUserPrivilegesResponseDocument.GetUserPrivilegesResponse getUserPrivileges(java.lang.String userGuid)
                                                                                                           throws com.tibco.n2.de.services.InvalidEntityReferenceFault,
                                                                                                                  com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                                                                  com.tibco.n2.de.services.InternalServiceFault

Description copied from interface: SecurityService

Returns the privilege assignments for the Resource identified by the given GUID. The Resource need not be a HumanResource. The Privileges are derived from the Groups and Positions to which the Resource belongs.

Specified by:

getUserPrivileges in interface SecurityService

Parameters:

userGuid - The user Guid.

Returns:

Returns a UserPrivileges object which contains a list of user privileges.

Throws:

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

isActionAuthorised

public com.tibco.n2.de.api.security.IsActionAuthorisedResponseDocument.IsActionAuthorisedResponse isActionAuthorised(com.tibco.n2.common.organisation.api.XmlModelEntityId scope,
                                                                                                                     com.tibco.n2.common.organisation.api.XmlModelEntityId performer,
                                                                                                                     com.tibco.n2.de.api.security.XmlSystemAction[] action,
                                                                                                                     boolean faultOnUnauthorised)
                                                                                                              throws com.tibco.n2.de.services.SecurityFault,
                                                                                                                     com.tibco.n2.de.services.InvalidEntityReferenceFault,
                                                                                                                     com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                                                                     com.tibco.n2.de.services.InternalServiceFault

Description copied from interface: SecurityService

Tests whether the caller (determined by the SOAP security header) is authorised to perform the named System Action in the context of the targeted Organisational Entity.

Specified by:

isActionAuthorised in interface SecurityService

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

isActionAuthorised

public com.tibco.n2.de.api.security.IsActionAuthorisedResponseDocument.IsActionAuthorisedResponse isActionAuthorised(com.tibco.n2.common.organisation.api.XmlModelEntityId scope,
                                                                                                                     com.tibco.n2.de.api.security.XmlSystemAction[] action,
                                                                                                                     boolean faultOnUnauthorised)
                                                                                                              throws com.tibco.n2.de.services.SecurityFault,
                                                                                                                     com.tibco.n2.de.services.InvalidEntityReferenceFault,
                                                                                                                     com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                                                                     com.tibco.n2.de.services.InternalServiceFault

Description copied from interface: SecurityService

Tests whether the caller (determined by the SOAP security header) is authorised to perform the named System Action in the context of the targeted Organisational Entity.

Specified by:

isActionAuthorised in interface SecurityService

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

listActionAuthorisedEntities

public com.tibco.n2.de.api.security.ListActionAuthorisedEntitiesResponseDocument.ListActionAuthorisedEntitiesResponse listActionAuthorisedEntities(java.lang.String component,
                                                                                                                                                   java.lang.String name)
                                                                                                                                            throws com.tibco.n2.de.services.SecurityFault,
                                                                                                                                                   com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                                                                                                   com.tibco.n2.de.services.InternalServiceFault

Description copied from interface: SecurityService

Returns a list of Entities which the caller (determined by the SOAP security header) is authorised to perform the named System Action on.

Specified by:

listActionAuthorisedEntities in interface SecurityService

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

listAuthorisedOrgs

public com.tibco.n2.de.api.security.ListAuthorisedOrgsResponseDocument.ListAuthorisedOrgsResponse listAuthorisedOrgs(java.lang.String component,
                                                                                                                     java.lang.String name)
                                                                                                              throws com.tibco.n2.de.services.SecurityFault,
                                                                                                                     com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                                                                     com.tibco.n2.de.services.InternalServiceFault

Description copied from interface: SecurityService

Returns a list of Organisation GUIDs which the caller (determined by the SOAP security header) is authorised to perform the named System Action on.

Specified by:

listAuthorisedOrgs in interface SecurityService

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault