com.tibco.n2.service.adapter.binding

Interface SecurityService

All Known Implementing Classes:

SecurityService

public interface SecurityService

Interface to provide the SecurityService methods in the Service Adapter.

The Security Service provides a method of authenticating users against their LDAP entry.

User Privileges can also be retrieved and updated using this service.

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.

Method Detail

authenticateUser

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

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

Parameters:

password - A byte array containing base64 encoded password.

login - Login name.

Returns:

Returns AuthenticateUserResponse which contains the guid if successful.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

getUserPrivileges

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

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.

Parameters:

userGuid - The user Guid.

Returns:

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

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

isActionAuthorised

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

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.

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

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

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.

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

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

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

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

listAuthorisedOrgs

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

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

Throws:

com.tibco.n2.de.services.SecurityFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault