|
||||||||||
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.
ConnectorFactory
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 |
configure(ResourceConfigurationType configuration,
OperationResult parentResult)
The connector instance will be configured to the state that it can immediately access the resource. |
void |
deleteObject(ResourceObjectDefinition objectClass,
java.util.Set<Operation> additionalOperations,
java.util.Collection<? extends 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(ResourceObjectDefinition objectClass,
Property lastToken,
OperationResult parentResult)
Token may be null. |
Property |
fetchCurrentToken(ResourceObjectDefinition objectClass,
OperationResult parentResult)
Returns the latest token. |
ResourceObject |
fetchObject(ResourceObjectDefinition objectClass,
java.util.Collection<? extends ResourceObjectAttribute> identifiers,
boolean returnDefaultAttributes,
java.util.Collection<? extends ResourceObjectAttributeDefinition> attributesToReturn,
OperationResult parentResult)
Retrieves a specific object from the resource. |
Schema |
generateConnectorSchema()
|
java.util.Set<java.lang.Object> |
getCapabilities(OperationResult parentResult)
Retrieves native connector capabilities. |
Schema |
getResourceSchema(OperationResult parentResult)
Retrieves the schema from the resource. |
void |
initialize(OperationResult parentResult)
Get necessary information from the remote system. |
java.util.Set<AttributeModificationOperation> |
modifyObject(ResourceObjectDefinition objectClass,
java.util.Collection<? extends ResourceObjectAttribute> identifiers,
java.util.Set<Operation> changes,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g. |
void |
search(ResourceObjectDefinition objectClass,
ResultHandler handler,
OperationResult parentResult)
Execute iterative search operation. |
void |
test(OperationResult parentResult)
|
Method Detail |
---|
void configure(ResourceConfigurationType configuration, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException
configuration
-
CommunicationException
GenericFrameworkException
SchemaException
Schema generateConnectorSchema()
void initialize(OperationResult parentResult) throws CommunicationException, GenericFrameworkException
parentResult
-
CommunicationException
GenericFrameworkException
java.util.Set<java.lang.Object> getCapabilities(OperationResult parentResult) throws CommunicationException, GenericFrameworkException
parentResult
-
CommunicationException
GenericFrameworkException
Schema getResourceSchema(OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
- error in communication to the resource
- nothing was fetched.
GenericFrameworkException
Schema
ResourceObject fetchObject(ResourceObjectDefinition objectClass, java.util.Collection<? extends ResourceObjectAttribute> identifiers, boolean returnDefaultAttributes, java.util.Collection<? extends ResourceObjectAttributeDefinition> attributesToReturn, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException
objectClass
- objectClass of the object to fetch (QName).identifiers
- primary identifiers of the object.
CommunicationException
- error in communication to the resource
- nothing was fetched.
SchemaException
- error converting object from native (connector) format
ObjectNotFoundException
GenericFrameworkException
void search(ResourceObjectDefinition objectClass, ResultHandler handler, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException
objectClass
- handler
-
CommunicationException
SchemaException
- error converting object from the native (connector) format
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
java.util.Set<AttributeModificationOperation> modifyObject(ResourceObjectDefinition objectClass, java.util.Collection<? extends ResourceObjectAttribute> identifiers, java.util.Set<Operation> changes, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException
identifiers
- changes
-
CommunicationException
SchemaException
ObjectNotFoundException
GenericFrameworkException
void deleteObject(ResourceObjectDefinition objectClass, java.util.Set<Operation> additionalOperations, java.util.Collection<? extends ResourceObjectAttribute> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
ObjectNotFoundException
CommunicationException
GenericFrameworkException
Property deserializeToken(java.lang.Object serializedToken)
serializedToken
-
Property fetchCurrentToken(ResourceObjectDefinition objectClass, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
GenericFrameworkException
java.util.List<Change> fetchChanges(ResourceObjectDefinition 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 |