com.tibco.n2.service.adapter.binding

Interface MappingService

All Known Implementing Classes:

MappingService

public interface MappingService

Provides services to allow the creation of Resources (Human, Consumable and Durable) within Directory Engine. Resources are derived from entries within one or more LDAP directories.

©2008 TIBCO Software Inc.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteResource(java.lang.String resourceGuid) Deletes the Resource identified by the given GUID.
com.tibco.n2.de.api.XmlLdapEntity	getResourceGuid(com.tibco.n2.de.api.XmlLdapEntity entity) Locates or creates an Org-Model Resource using the LDAP properties in the request.
com.tibco.n2.de.api.XmlResourceDetail[]	listMappedEntities(com.tibco.n2.common.organisation.api.XmlModelEntityId parentEntity) Returns the Resources directly associated with the org-model entity identified by the given parameters.
com.tibco.n2.de.api.XmlResourceDetail[]	listMappedEntities(com.tibco.n2.common.organisation.api.XmlModelEntityId parentEntity, boolean aCurrentOnly) Returns the Resources directly associated with the org-model entity identified by the given parameters.
com.tibco.n2.de.api.XmlEntityInstantiatedList	mapEntities(com.tibco.n2.de.api.XmlEntityMapping[] entityMapping) Processes a batch of mapping instructions.
boolean	updateCapabilityAssignments(com.tibco.n2.de.api.XmlCapabilityAssignment[] assignments) Updates the Capability assignments to Resources.

Method Detail

listMappedEntities

com.tibco.n2.de.api.XmlResourceDetail[] listMappedEntities(com.tibco.n2.common.organisation.api.XmlModelEntityId parentEntity)

                                                           throws com.tibco.n2.de.services.InternalServiceFault,

                                                                  com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                                  com.tibco.n2.de.services.InvalidEntityTypeFault,

                                                                  com.tibco.n2.de.services.InvalidOrgModelVersionFault

Returns the Resources directly associated with the org-model entity identified by the given parameters. For example, if the parameters identify a Position, this method will return those Resources that hold that Position.

Parameters:

parentEntity - the parent entity

Returns:

returns a List of mapped entities

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidEntityTypeFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

listMappedEntities

com.tibco.n2.de.api.XmlResourceDetail[] listMappedEntities(com.tibco.n2.common.organisation.api.XmlModelEntityId parentEntity,

                                                         boolean aCurrentOnly)

                                                           throws com.tibco.n2.de.services.InternalServiceFault,

                                                                  com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                                  com.tibco.n2.de.services.InvalidEntityTypeFault,

                                                                  com.tibco.n2.de.services.InvalidOrgModelVersionFault

Returns the Resources directly associated with the org-model entity identified by the given parameters. For example, if the parameters identify a Position, this method will return those Resources that hold that Position.

Parameters:

parentEntity - the parent entity

Returns:

returns a List of mapped entities

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidEntityTypeFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

mapEntities

com.tibco.n2.de.api.XmlEntityInstantiatedList mapEntities(com.tibco.n2.de.api.XmlEntityMapping[] entityMapping)

                                                          throws com.tibco.n2.de.services.InternalServiceFault,

                                                                 com.tibco.n2.de.services.InvalidLDAPSourceFault,

                                                                 com.tibco.n2.de.services.InvalidLDAPContainerFault,

                                                                 com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                                 com.tibco.n2.de.services.InvalidResourceMappingFault,

                                                                 com.tibco.n2.de.services.InvalidEntityTypeFault,

                                                                 com.tibco.n2.de.services.InvalidOrgModelVersionFault

Processes a batch of mapping instructions. Each instruction (XmlEntityMapping) specifies a target model entity (Position or Group) to/from which Resources assignments can be created or removed. When creating an assignment, a new Resource will be also be created if no existing Resource can be found for the given LDAP entry identifier or Organisational Model GUID.

Parameters:

entityRequest - The list of create/remove mapping instructions connecting Resources to target Organisational Model entities.

Returns:

The list of Resource LDAP identifiers that have been assigned to the identified Groups or Positions.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidLDAPSourceFault

com.tibco.n2.de.services.InvalidLDAPContainerFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidResourceMappingFault

com.tibco.n2.de.services.InvalidEntityTypeFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

getResourceGuid

com.tibco.n2.de.api.XmlLdapEntity getResourceGuid(com.tibco.n2.de.api.XmlLdapEntity entity)

                                                  throws com.tibco.n2.de.services.InvalidLDAPSourceFault,

                                                         com.tibco.n2.de.services.InternalServiceFault,

                                                         com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                         com.tibco.n2.de.services.InvalidLDAPContainerFault

Locates or creates an Org-Model Resource using the LDAP properties in the request. The GUID of the resource will be returned in the XmlLdapEntity. If no Org-Model Resource could be located, one will be created, and linked to the identified LDAP entry.

Parameters:

entity - the entity object

Returns:

returns a LDAP Entity

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InvalidLDAPSourceFault

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidLDAPContainerFault

deleteResource

boolean deleteResource(java.lang.String resourceGuid)

                       throws com.tibco.n2.de.services.InternalDAOErrorFault,

                              com.tibco.n2.de.services.InternalServiceFault,

                              com.tibco.n2.de.services.InvalidEntityReferenceFault

Deletes the Resource identified by the given GUID. Any associations the Resource holds are also deleted. Any interested parties are notified of the deletion before it occurs, but cannot veto the deletion.

Parameters:

resourceGuid - the guid for a resource

Returns:

returns a true if successful, otherwise false

Throws:

com.tibco.n2.de.services.InternalDAOErrorFault

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

updateCapabilityAssignments

boolean updateCapabilityAssignments(com.tibco.n2.de.api.XmlCapabilityAssignment[] assignments)

                                    throws com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                           com.tibco.n2.de.services.InvalidServiceRequestFault,

                                           com.tibco.n2.de.services.InternalServiceFault,

                                           com.tibco.n2.de.services.InvalidOrgModelVersionFault

Updates the Capability assignments to Resources. Any number of Resources may be amended with the one call. The parameter is an array of assignment modifications. Each modification identifies the Resource to which the assignment applies, by its GUID, and the Capability, by its GUID. A boolean indicator shows whether the assignment is to be created or removed. If the Capability is a qualified one, the qualifying value can also be specified.

Parameters:

assignments - A List of Capability assignment modifications.

Returns:

returns true if successful, otherwise false

Throws:

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault