|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConnectorInstance
Connector instance configured for a specific resource. This is kind of connector facade. It is an API provided by the "Unified Connector Framework" to the midPoint provisioning component. There is no associated SPI yet. That may come in the future when this interface stabilizes a bit. This interface provides an unified facade to a connector capabilities in the Unified Connector Framework interface. The connector is configured to a specific resource instance and therefore can execute operations on resource. Calls to this interface always try to reach the resource and get the actual state on resource. The connectors are not supposed to cache any information. Therefore the methods do not follow get/set java convention as the data are not regular javabean properties.
TODO: rich operation result
Method Summary | |
---|---|
java.util.Set<ResourceObjectAttribute> |
addObject(ResourceObject object,
java.util.Set<Operation> additionalOperations,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g. |
void |
deleteObject(javax.xml.namespace.QName objectClass,
java.util.Set<ResourceObjectAttribute> identifiers,
OperationResult parentResult)
|
Property |
deserializeToken(java.lang.Object serializedToken)
Creates a live Java object from a token previously serialized to string. |
java.util.List<Change> |
fetchChanges(javax.xml.namespace.QName objectClass,
Property lastToken,
OperationResult parentResult)
Token may be null. |
Property |
fetchCurrentToken(javax.xml.namespace.QName objectClass,
OperationResult parentResult)
Returns the latest token. |
ResourceObject |
fetchObject(javax.xml.namespace.QName objectClass,
java.util.Set<ResourceObjectAttribute> identifiers,
OperationResult parentResult)
Retrieves a specific object from the resource. |
ResourceObject |
fetchObject(ResourceObjectDefinition resourceObjectDefinition,
java.util.Set<ResourceObjectAttribute> identifiers,
OperationResult parentResult)
|
Schema |
fetchResourceSchema(OperationResult parentResult)
Retrieves the schema from the resource. |
void |
modifyObject(javax.xml.namespace.QName objectClass,
java.util.Set<ResourceObjectAttribute> identifiers,
java.util.Set<Operation> changes,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g. |
void |
search(javax.xml.namespace.QName objectClass,
ResourceObjectDefinition definition,
ResultHandler handler,
OperationResult parentResult)
Execute iterative search operation. |
void |
test(OperationResult parentResult)
|
Method Detail |
---|
Schema fetchResourceSchema(OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
- error in communication to the resource
- nothing was fetched.
GenericFrameworkException
Schema
ResourceObject fetchObject(javax.xml.namespace.QName objectClass, java.util.Set<ResourceObjectAttribute> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
objectClass
- objectClass of the object to fetch (QName).identifiers
- primary identifiers of the object.
CommunicationException
- error in communication to the resource
- nothing was fetched.
ObjectNotFoundException
GenericFrameworkException
ResourceObject fetchObject(ResourceObjectDefinition resourceObjectDefinition, java.util.Set<ResourceObjectAttribute> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
ObjectNotFoundException
CommunicationException
GenericFrameworkException
void search(javax.xml.namespace.QName objectClass, ResourceObjectDefinition definition, ResultHandler handler, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
objectClass
- handler
-
CommunicationException
GenericFrameworkException
java.util.Set<ResourceObjectAttribute> addObject(ResourceObject object, java.util.Set<Operation> additionalOperations, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ObjectAlreadyExistsException
object
- additionalOperations
-
CommunicationException
SchemaException
- resource schema violation
ObjectAlreadyExistsException
- object already exists on the resource
GenericFrameworkException
void modifyObject(javax.xml.namespace.QName objectClass, java.util.Set<ResourceObjectAttribute> identifiers, java.util.Set<Operation> changes, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException
identifiers
- changes
-
CommunicationException
SchemaException
ObjectNotFoundException
GenericFrameworkException
void deleteObject(javax.xml.namespace.QName objectClass, java.util.Set<ResourceObjectAttribute> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
ObjectNotFoundException
CommunicationException
GenericFrameworkException
Property deserializeToken(java.lang.Object serializedToken)
serializedToken
-
Property fetchCurrentToken(javax.xml.namespace.QName objectClass, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
GenericFrameworkException
java.util.List<Change> fetchChanges(javax.xml.namespace.QName objectClass, Property lastToken, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException
lastToken
-
CommunicationException
GenericFrameworkException
SchemaException
void test(OperationResult parentResult)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |