Package org.odpi.openmetadata.frameworks.integration.iterator

Class IntegrationIterator

java.lang.Object

org.odpi.openmetadata.frameworks.integration.iterator.IntegrationIterator

Direct Known Subclasses:

MetadataCollectionIterator, RelatedElementsIterator

public abstract class IntegrationIterator
extends Object

IntegrationIterator provides the common logic for an integration iterator.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AuditLog	auditLog
protected final String	catalogTargetName
protected final String	connectorName
protected List<OpenMetadataElement>	elementCache
protected final String	externalScopeGUID
protected final String	externalScopeName
protected final int	maxPageSize
protected final String	metadataCollectionGUID
protected final String	metadataCollectionQualifiedName
protected final String	metadataTypeName
protected final OpenMetadataAccess	openMetadataAccess
protected final PropertyHelper	propertyHelper
protected int	startFrom
protected final PermittedSynchronization	targetPermittedSynchronization

Constructor Summary

Constructors

Constructor	Description
IntegrationIterator(String metadataCollectionGUID, String metadataCollectionQualifiedName, String externalScopeGUID, String externalScopeName, String catalogTargetName, String connectorName, String metadataTypeName, OpenMetadataAccess openMetadataAccess, PermittedSynchronization targetPermittedSynchronization, int maxPageSize, AuditLog auditLog)	Create the iterator.

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	fillCache()	Retrieve information from the open metadata repositories.
MemberElement	getMemberByQualifiedName(String qualifiedName)	Retrieve the member element by qualified name.
MemberElement	getNextMember()	Return the next element.
boolean	moreToReceive()	Is there information from the open metadata repositories to process?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

propertyHelper

protected final PropertyHelper propertyHelper

metadataCollectionGUID

protected final String metadataCollectionGUID

metadataCollectionQualifiedName

protected final String metadataCollectionQualifiedName

externalScopeGUID

protected final String externalScopeGUID

externalScopeName

protected final String externalScopeName

catalogTargetName

protected final String catalogTargetName

connectorName

protected final String connectorName

metadataTypeName

protected final String metadataTypeName

openMetadataAccess

protected final OpenMetadataAccess openMetadataAccess

targetPermittedSynchronization

protected final PermittedSynchronization targetPermittedSynchronization

maxPageSize

protected final int maxPageSize

auditLog

protected final AuditLog auditLog

elementCache

protected List<OpenMetadataElement> elementCache

startFrom

protected int startFrom

Constructor Details

IntegrationIterator

public IntegrationIterator(String metadataCollectionGUID,
 String metadataCollectionQualifiedName,
 String externalScopeGUID,
 String externalScopeName,
 String catalogTargetName,
 String connectorName,
 String metadataTypeName,
 OpenMetadataAccess openMetadataAccess,
 PermittedSynchronization targetPermittedSynchronization,
 int maxPageSize,
 AuditLog auditLog)

Create the iterator.

Parameters:

metadataCollectionGUID - unique identifier of the metadata collection

metadataCollectionQualifiedName - unique name of the metadata collection

externalScopeGUID - unique identifier for the owning scope (typically a catalog)

externalScopeName - unique name for the owning scope (typically a catalog)

catalogTargetName - name of target

connectorName - name of the calling connector

metadataTypeName - type of element to receive

openMetadataAccess - client to access metadata

targetPermittedSynchronization - the synchronization policy for this target

maxPageSize - max page size for the server

auditLog - logging destination

Method Details

fillCache

protected abstract boolean fillCache()
                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve information from the open metadata repositories.

Returns:

boolean where true means there are elements to process.

Throws:

InvalidParameterException - problem with a parameter value

PropertyServerException - repository not working properly

UserNotAuthorizedException - permissions problem

moreToReceive

public boolean moreToReceive()
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Is 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 value

PropertyServerException - repository not working properly

UserNotAuthorizedException - permissions problem

getNextMember

public MemberElement getNextMember()
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the next element.

Returns:

next member in the repository.

Throws:

InvalidParameterException - problem with a parameter value

PropertyServerException - repository not working properly

UserNotAuthorizedException - 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 value

PropertyServerException - repository not working properly

UserNotAuthorizedException - permissions problem