|
||||||||||
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.Collection<ResourceAttribute<?>> |
addObject(PrismObject<? extends ResourceObjectShadowType> object,
java.util.Set<Operation> additionalOperations,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g. |
|
void |
configure(PrismContainerValue configuration,
OperationResult parentResult)
The connector instance will be configured to the state that it can immediately access the resource. |
|
void |
deleteObject(ObjectClassComplexTypeDefinition objectClass,
java.util.Set<Operation> additionalOperations,
java.util.Collection<? extends ResourceAttribute> identifiers,
OperationResult parentResult)
|
|
PrismProperty<?> |
deserializeToken(java.lang.Object serializedToken)
Creates a live Java object from a token previously serialized to string. |
|
java.util.List<Change> |
fetchChanges(ObjectClassComplexTypeDefinition objectClass,
PrismProperty lastToken,
OperationResult parentResult)
Token may be null. |
|
PrismProperty<?> |
fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass,
OperationResult parentResult)
Returns the latest token. |
|
|
fetchObject(java.lang.Class<T> type,
ObjectClassComplexTypeDefinition objectClassDefinition,
java.util.Collection<? extends ResourceAttribute> identifiers,
boolean returnDefaultAttributes,
java.util.Collection<? extends ResourceAttributeDefinition> attributesToReturn,
OperationResult parentResult)
Retrieves a specific object from the resource. |
|
PrismSchema |
generateConnectorSchema()
|
|
java.util.Collection<java.lang.Object> |
getCapabilities(OperationResult parentResult)
Retrieves native connector capabilities. |
|
ResourceSchema |
getResourceSchema(OperationResult parentResult)
Retrieves the schema from the resource. |
|
void |
initialize(OperationResult parentResult)
Get necessary information from the remote system. |
|
java.util.Set<PropertyModificationOperation> |
modifyObject(ObjectClassComplexTypeDefinition objectClass,
java.util.Collection<? extends ResourceAttribute> identifiers,
java.util.Collection<Operation> changes,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g. |
|
|
search(java.lang.Class<T> type,
ObjectClassComplexTypeDefinition objectClassDefinition,
ObjectQuery query,
ResultHandler<T> handler,
OperationResult parentResult)
Execute iterative search operation. |
|
void |
test(OperationResult parentResult)
|
Method Detail |
---|
void configure(PrismContainerValue configuration, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
configuration
-
ConfigurationException
CommunicationException
GenericFrameworkException
SchemaException
PrismSchema generateConnectorSchema()
void initialize(OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
parentResult
-
CommunicationException
GenericFrameworkException
ConfigurationException
java.util.Collection<java.lang.Object> getCapabilities(OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
parentResult
-
CommunicationException
GenericFrameworkException
ConfigurationException
ResourceSchema getResourceSchema(OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
CommunicationException
- error in communication to the resource
- nothing was fetched.
ConfigurationException
GenericFrameworkException
PrismSchema
<T extends ResourceObjectShadowType> PrismObject<T> fetchObject(java.lang.Class<T> type, ObjectClassComplexTypeDefinition objectClassDefinition, java.util.Collection<? extends ResourceAttribute> identifiers, boolean returnDefaultAttributes, java.util.Collection<? extends ResourceAttributeDefinition> attributesToReturn, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException
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
SecurityViolationException
<T extends ResourceObjectShadowType> void search(java.lang.Class<T> type, ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, ResultHandler<T> handler, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException
objectClass
- handler
-
CommunicationException
SchemaException
- error converting object from the native (connector) format
GenericFrameworkException
java.util.Collection<ResourceAttribute<?>> addObject(PrismObject<? extends ResourceObjectShadowType> 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<PropertyModificationOperation> modifyObject(ObjectClassComplexTypeDefinition objectClass, java.util.Collection<? extends ResourceAttribute> identifiers, java.util.Collection<Operation> changes, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException
identifiers
- changes
-
CommunicationException
SchemaException
ObjectNotFoundException
GenericFrameworkException
SecurityViolationException
void deleteObject(ObjectClassComplexTypeDefinition objectClass, java.util.Set<Operation> additionalOperations, java.util.Collection<? extends ResourceAttribute> identifiers, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException
ObjectNotFoundException
CommunicationException
GenericFrameworkException
PrismProperty<?> deserializeToken(java.lang.Object serializedToken)
serializedToken
-
PrismProperty<?> fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
GenericFrameworkException
java.util.List<Change> fetchChanges(ObjectClassComplexTypeDefinition objectClass, PrismProperty lastToken, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
lastToken
-
CommunicationException
GenericFrameworkException
SchemaException
ConfigurationException
void test(OperationResult parentResult)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |