Class IntegrationIterator
java.lang.Object
org.odpi.openmetadata.frameworks.integration.iterator.IntegrationIterator
- Direct Known Subclasses:
MetadataCollectionIterator
,RelatedElementsIterator
IntegrationIterator provides the common logic for an integration iterator.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final AuditLog
protected final String
protected final String
protected List<OpenMetadataElement>
protected final int
protected final String
protected final String
protected final String
protected final OpenMetadataAccess
protected final PropertyHelper
protected int
protected final PermittedSynchronization
-
Constructor Summary
ConstructorsConstructorDescriptionIntegrationIterator
(String metadataCollectionGUID, String metadataCollectionQualifiedName, String catalogTargetName, String connectorName, String metadataTypeName, OpenMetadataAccess openMetadataAccess, PermittedSynchronization targetPermittedSynchronization, int maxPageSize, AuditLog auditLog) Create the iterator. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract boolean
Retrieve information from the open metadata repositories.getMemberByQualifiedName
(String qualifiedName) Retrieve the member element by qualified name.Return the next element.boolean
Is there information from the open metadata repositories to process?
-
Field Details
-
propertyHelper
-
metadataCollectionGUID
-
metadataCollectionQualifiedName
-
catalogTargetName
-
connectorName
-
metadataTypeName
-
openMetadataAccess
-
targetPermittedSynchronization
-
maxPageSize
protected final int maxPageSize -
auditLog
-
elementCache
-
startFrom
protected int startFrom
-
-
Constructor Details
-
IntegrationIterator
public IntegrationIterator(String metadataCollectionGUID, String metadataCollectionQualifiedName, String catalogTargetName, String connectorName, String metadataTypeName, OpenMetadataAccess openMetadataAccess, PermittedSynchronization targetPermittedSynchronization, int maxPageSize, AuditLog auditLog) Create the iterator.- Parameters:
metadataCollectionGUID
- unique identifier of the metadata collectionmetadataCollectionQualifiedName
- unique name of the metadata collectioncatalogTargetName
- name of targetconnectorName
- name of the calling connectormetadataTypeName
- type of element to receiveopenMetadataAccess
- client to access metadatatargetPermittedSynchronization
- the synchronization policy for this targetmaxPageSize
- max page size for the serverauditLog
- logging destination
-
-
Method Details
-
fillCache
protected abstract boolean fillCache() throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionRetrieve information from the open metadata repositories.- Returns:
- boolean where true means there are elements to process.
- Throws:
InvalidParameterException
- problem with a parameter valuePropertyServerException
- repository not working properlyUserNotAuthorizedException
- permissions problem
-
moreToReceive
public boolean moreToReceive() throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionIs there information from the open metadata repositories to process?- Returns:
- boolean where true means there are elements to process.
- Throws:
InvalidParameterException
- problem with a parameter valuePropertyServerException
- repository not working properlyUserNotAuthorizedException
- permissions problem
-
getNextMember
public MemberElement getNextMember() throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionReturn the next element.- Returns:
- next member in the repository.
- Throws:
InvalidParameterException
- problem with a parameter valuePropertyServerException
- repository not working properlyUserNotAuthorizedException
- permissions problem
-
getMemberByQualifiedName
public MemberElement getMemberByQualifiedName(String qualifiedName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Retrieve the member element by qualified name. This is used in sweep 2 when elements from the third party system are being retrieved and mapped to open metadata elements. It is possible that there is no open metadata element, or it has been deleted.- Parameters:
qualifiedName
- anticipated qualified name.- Returns:
- member element - may be empty - but not null
- Throws:
InvalidParameterException
- problem with a parameter valuePropertyServerException
- repository not working properlyUserNotAuthorizedException
- permissions problem
-