public interface ConnectorInstance
ConnectorFactory
Modifier and Type | Method and Description |
---|---|
Collection<ResourceAttribute<?>> |
addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> object,
Collection<Operation> additionalOperations,
StateReporter reporter,
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.
|
int |
count(ObjectClassComplexTypeDefinition objectClassDefinition,
ObjectQuery query,
com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchConfigurationType,
StateReporter reporter,
OperationResult parentResult)
Counts objects on resource.
|
void |
deleteObject(ObjectClassComplexTypeDefinition objectClass,
Collection<Operation> additionalOperations,
Collection<? extends ResourceAttribute<?>> identifiers,
StateReporter reporter,
OperationResult parentResult) |
PrismProperty<?> |
deserializeToken(Object serializedToken)
Creates a live Java object from a token previously serialized to string.
|
void |
dispose() |
Object |
executeScript(ExecuteProvisioningScriptOperation scriptOperation,
StateReporter reporter,
OperationResult parentResult) |
Collection<Object> |
fetchCapabilities(OperationResult parentResult)
Retrieves native connector capabilities.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
fetchChanges(ObjectClassComplexTypeDefinition objectClass,
PrismProperty<?> lastToken,
AttributesToReturn attrsToReturn,
StateReporter reporter,
OperationResult parentResult)
Token may be null.
|
<T> PrismProperty<T> |
fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass,
StateReporter reporter,
OperationResult parentResult)
Returns the latest token.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
fetchObject(Class<T> type,
ResourceObjectIdentification resourceObjectIdentification,
AttributesToReturn attributesToReturn,
StateReporter reporter,
OperationResult parentResult)
Retrieves a specific object from the resource.
|
ResourceSchema |
fetchResourceSchema(List<QName> generateObjectClasses,
OperationResult parentResult)
Retrieves the schema from the resource.
|
PrismSchema |
generateConnectorSchema() |
ConnectorOperationalStatus |
getOperationalStatus() |
void |
initialize(ResourceSchema resourceSchema,
Collection<Object> capabilities,
boolean caseIgnoreAttributeNames,
OperationResult parentResult)
Get necessary information from the remote system.
|
Collection<PropertyModificationOperation> |
modifyObject(ObjectClassComplexTypeDefinition objectClass,
Collection<? extends ResourceAttribute<?>> identifiers,
Collection<Operation> changes,
StateReporter reporter,
OperationResult parentResult)
TODO: This should return indication how the operation went, e.g.
|
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> |
search(ObjectClassComplexTypeDefinition objectClassDefinition,
ObjectQuery query,
ResultHandler<T> handler,
AttributesToReturn attributesToReturn,
com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchConfigurationType,
SearchHierarchyConstraints searchHierarchyConstraints,
StateReporter reporter,
OperationResult parentResult)
Execute iterative search operation.
|
void |
test(OperationResult parentResult) |
void configure(PrismContainerValue<?> configuration, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
configuration
- ConfigurationException
CommunicationException
GenericFrameworkException
SchemaException
ConnectorOperationalStatus getOperationalStatus() throws ObjectNotFoundException
ObjectNotFoundException
PrismSchema generateConnectorSchema()
void initialize(ResourceSchema resourceSchema, Collection<Object> capabilities, boolean caseIgnoreAttributeNames, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
caseIgnoreAttributeNames
- parentResult
- CommunicationException
GenericFrameworkException
ConfigurationException
Collection<Object> fetchCapabilities(OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
parentResult
- CommunicationException
GenericFrameworkException
ConfigurationException
ResourceSchema fetchResourceSchema(List<QName> generateObjectClasses, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, ConfigurationException
CommunicationException
- error in communication to the resource
- nothing was fetched.ConfigurationException
GenericFrameworkException
PrismSchema
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObject<T> fetchObject(Class<T> type, ResourceObjectIdentification resourceObjectIdentification, AttributesToReturn attributesToReturn, StateReporter reporter, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException, ConfigurationException
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) formatObjectNotFoundException
GenericFrameworkException
SecurityViolationException
ConfigurationException
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> SearchResultMetadata search(ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, ResultHandler<T> handler, AttributesToReturn attributesToReturn, com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchConfigurationType, SearchHierarchyConstraints searchHierarchyConstraints, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException, ObjectNotFoundException
objectClass
- handler
- CommunicationException
SchemaException
- error converting object from the native (connector) formatObjectNotFoundException
- if something from the search parameters refers non-existent object.
e.g. if search base points to an non-existent object.GenericFrameworkException
SecurityViolationException
int count(ObjectClassComplexTypeDefinition objectClassDefinition, ObjectQuery query, com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.PagedSearchCapabilityType pagedSearchConfigurationType, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, UnsupportedOperationException
objectClassDefinition
- query
- pagedSearchConfigurationType
- parentResult
- CommunicationException
SchemaException
UnsupportedOperationException
GenericFrameworkException
Collection<ResourceAttribute<?>> addObject(PrismObject<? extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> object, Collection<Operation> additionalOperations, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ObjectAlreadyExistsException, ConfigurationException
object
- additionalOperations
- CommunicationException
SchemaException
- resource schema violationObjectAlreadyExistsException
- object already exists on the resourceGenericFrameworkException
ConfigurationException
Collection<PropertyModificationOperation> modifyObject(ObjectClassComplexTypeDefinition objectClass, Collection<? extends ResourceAttribute<?>> identifiers, Collection<Operation> changes, StateReporter reporter, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException, SecurityViolationException, ObjectAlreadyExistsException
identifiers
- The set of identifiers. Their values may change as a result of the operation, e.g. when the resource object is renamed.changes
- CommunicationException
SchemaException
ObjectAlreadyExistsException
- in case that the modified object conflicts with another existing object (e.g. while renaming an object)ObjectNotFoundException
GenericFrameworkException
SecurityViolationException
void deleteObject(ObjectClassComplexTypeDefinition objectClass, Collection<Operation> additionalOperations, Collection<? extends ResourceAttribute<?>> identifiers, StateReporter reporter, OperationResult parentResult) throws ObjectNotFoundException, CommunicationException, GenericFrameworkException, SchemaException
Object executeScript(ExecuteProvisioningScriptOperation scriptOperation, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
PrismProperty<?> deserializeToken(Object serializedToken)
serializedToken
- <T> PrismProperty<T> fetchCurrentToken(ObjectClassComplexTypeDefinition objectClass, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException
CommunicationException
GenericFrameworkException
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<Change<T>> fetchChanges(ObjectClassComplexTypeDefinition objectClass, PrismProperty<?> lastToken, AttributesToReturn attrsToReturn, StateReporter reporter, OperationResult parentResult) throws CommunicationException, GenericFrameworkException, SchemaException, ConfigurationException
lastToken
- CommunicationException
GenericFrameworkException
SchemaException
ConfigurationException
void test(OperationResult parentResult)
void dispose()
Copyright © 2016 evolveum. All rights reserved.