Class RepositoryConformanceWorkPad
java.lang.Object
org.odpi.openmetadata.conformance.beans.OpenMetadataConformanceWorkbenchWorkPad
org.odpi.openmetadata.conformance.workbenches.repository.RepositoryConformanceWorkPad
RepositoryConformanceWorkPad provides the thread safe place to assemble results from the repository workbench.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.conformance.beans.OpenMetadataConformanceWorkbenchWorkPad
lastActive, localServerPassword, localServerUserId, maxPageSize, testCaseMap, testEvidenceList, tutName, workbenchComplete
-
Constructor Summary
ConstructorsConstructorDescriptionRepositoryConformanceWorkPad
(String localServerUserId, String localServerPassword, int maxPageSize, AuditLog auditLog, RepositoryConformanceWorkbenchConfig configuration) Constructor receives key information from the configuration services. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEntityInstanceSets
(String entityTypeName, List<EntityDetail> set_0, List<EntityDetail> set_1, List<EntityDetail> set_2) Remember the sets of instances for a given entity type.void
addRelationshipInstanceSets
(String relationshipTypeName, List<Relationship> set_0, List<Relationship> set_1, List<Relationship> set_2) Remember the sets of instances for a given relationship type.void
addSupportedAttributeTypeDefFromEvent
(AttributeTypeDef attributeTypeDef) Add a TypeDef to the list of supported type definitions.void
addSupportedTypeDefFromEvent
(TypeDef typeDef) Add a TypeDef to the list of supported type definitions.Return a type definition object by name (or null if not known)Return a specific type definition received in an OMRS event.Return a specific type definition received from the REST API.Return the audit log for this server.getEntityInstanceSet
(String entityTypeName, int setId) Retrieve entity instances for the given type for the given instance setgetEntityRelationshipTypes
(String entityTypeName) Return the list of end types for the named relationship type.getEntitySubTypes
(String entityTypeName) Return the list of subtypes of the named entity typeReturn the set of supported entity type namesReturn the metadata collection id for the local repository.Return the connector to the local repository.int
Return the maximum number of search results that be processed for tests of the repository under test.Accumulate the set of profile names registered with this work pad.Accumulate the evidences for each profilegetProfileResults
(String profileName) Accumulate the evidences for a given profile.Accumulate the summarized evidences for each profilegetRelationshipEndTypes
(String relationshipTypeName) Return the list of end types for the named relationship typegetRelationshipInstanceSet
(String relationshipTypeName, int setId) Retrieve relationship instances for the given type for the given instance setgetRelationshipSubTypes
(String relationshipTypeName) Return the list of subtypes of the named relationship typeReturn the set of supported relationship type namesReturn the list of entity types to test.Return the metadata collection id of the technology under test (or null if it is not known).Return the owning organization of the technology under test.Return the repository connector for the technology under test.Return the name of the server being tested.Return the server type of the technology under test.getTypeDefByName
(String name) Return a type definition object by name (or null if not known)getTypeDefFromEvents
(String guid) Return a specific type definition received in an OMRS event.getTypeDefFromRESTAPI
(String guid) Return a specific type definition received from the REST API.void
removeEntityInstanceSets
(String entityTypeName) Clean up entity instances for the given type.void
removeRelationshipInstanceSets
(String relationshipTypeName) Clean up relationship instances for the given type.void
setLocalMetadataCollectionId
(String localMetadataCollectionId) Set up the metadata collection id for the local repository.void
setLocalRepositoryConnector
(OMRSRepositoryConnector localRepositoryConnector) Set up the connector to the local repository.void
setSupportedAttributeTypeDefsFromRESTAPI
(List<AttributeTypeDef> supportedAttributeTypeDefs) Set up the supported attributeTypeDefs for validation.void
setSupportedTypeDefsFromRESTAPI
(List<TypeDef> supportedTypeDefs) Set up the supported typeDefs for validation.void
setTutMetadataCollectionId
(String tutMetadataCollectionId) Set up the metadata collection id of the technology under test.void
setTutOrganization
(String tutOrganization) Set up the owning organization of the technology under test.void
setTutRepositoryConnector
(OMRSRepositoryConnector tutRepositoryConnector) Set up the repository connector for the technology under test.void
setTutServerType
(String tutServerType) Set up the server type of the technology under test.toString()
toString() JSON-styleMethods inherited from class org.odpi.openmetadata.conformance.beans.OpenMetadataConformanceWorkbenchWorkPad
addDiscoveredProperty, addNotSupportedCondition, addSuccessfulCondition, addUnsuccessfulCondition, getLocalServerPassword, getLocalServerUserId, getMaxPageSize, getWorkbenchDocURL, getWorkbenchId, getWorkbenchName, getWorkbenchStatus, getWorkbenchVersionNumber, processEvidence, registerActivity, setWorkbenchComplete
-
Constructor Details
-
RepositoryConformanceWorkPad
public RepositoryConformanceWorkPad(String localServerUserId, String localServerPassword, int maxPageSize, AuditLog auditLog, RepositoryConformanceWorkbenchConfig configuration) Constructor receives key information from the configuration services.- Parameters:
localServerUserId
- userId that this server should use on requestslocalServerPassword
- password that this server should use on requestsmaxPageSize
- maximum number of elements that can be returned on a single callauditLog
- audit log for administrator messagesconfiguration
- configuration for this work pad/workbench
-
-
Method Details
-
getAuditLog
Return the audit log for this server.- Returns:
- audit log object.
-
getTutServerName
Return the name of the server being tested.- Returns:
- server name
-
getMaxSearchResults
public int getMaxSearchResults()Return the maximum number of search results that be processed for tests of the repository under test.- Returns:
- maximum number of search results to process
-
getTestEntityTypes
Return the list of entity types to test. If the value is null then all known entities will be used. The names of the entities are used to drive the spawning of tests since the repository workbench aims to test each permutation of types.- Returns:
- list of entity type names
-
getTutServerType
Return the server type of the technology under test. This is extracted from the registration events.- Returns:
- string type name
-
setTutServerType
Set up the server type of the technology under test. This is extracted from the registration events.- Parameters:
tutServerType
- string type name
-
getTutOrganization
Return the owning organization of the technology under test. This is extracted from the registration event.- Returns:
- string organization name
-
setTutOrganization
Set up the owning organization of the technology under test. This is extracted from the registration event.- Parameters:
tutOrganization
- string organization name
-
getTutMetadataCollectionId
Return the metadata collection id of the technology under test (or null if it is not known). This value is populated from the registration events.- Returns:
- string id
-
setTutMetadataCollectionId
Set up the metadata collection id of the technology under test. This value is populated from the registration events.- Parameters:
tutMetadataCollectionId
- string id
-
setSupportedAttributeTypeDefsFromRESTAPI
public void setSupportedAttributeTypeDefsFromRESTAPI(List<AttributeTypeDef> supportedAttributeTypeDefs) Set up the supported attributeTypeDefs for validation. This list comes from the REST API.- Parameters:
supportedAttributeTypeDefs
- list of attributeTypeDefs
-
addSupportedAttributeTypeDefFromEvent
Add a TypeDef to the list of supported type definitions. This value comes from the events.- Parameters:
attributeTypeDef
- type definition object
-
getAttributeTypeDefByName
Return a type definition object by name (or null if not known)- Parameters:
name
- name of type definition object- Returns:
- attributeTypeDef object
-
getAttributeTypeDefFromRESTAPI
Return a specific type definition received from the REST API.- Parameters:
guid
- unique identifier of the required type definition- Returns:
- type definition object or null if not known
-
getAttributeTypeDefFromEvents
Return a specific type definition received in an OMRS event.- Parameters:
guid
- unique identifier of the required type definition- Returns:
- type definition object or null if not known
-
setSupportedTypeDefsFromRESTAPI
Set up the supported typeDefs for validation. This list comes from the REST API.- Parameters:
supportedTypeDefs
- list of typeDefs
-
addSupportedTypeDefFromEvent
Add a TypeDef to the list of supported type definitions. This value comes from the events.- Parameters:
typeDef
- type definition object
-
getTypeDefByName
Return a type definition object by name (or null if not known)- Parameters:
name
- name of type definition object- Returns:
- typeDef object
-
getTypeDefFromRESTAPI
Return a specific type definition received from the REST API.- Parameters:
guid
- unique identifier of the required type definition- Returns:
- type definition object or null if not known
-
getTypeDefFromEvents
Return a specific type definition received in an OMRS event.- Parameters:
guid
- unique identifier of the required type definition- Returns:
- type definition object or null if not known
-
getTutRepositoryConnector
Return the repository connector for the technology under test.- Returns:
- OMRSRepositoryConnector
-
setTutRepositoryConnector
Set up the repository connector for the technology under test.- Parameters:
tutRepositoryConnector
- OMRSRepositoryConnector
-
getLocalMetadataCollectionId
Return the metadata collection id for the local repository.- Returns:
- string id
-
setLocalMetadataCollectionId
Set up the metadata collection id for the local repository.- Parameters:
localMetadataCollectionId
- string id
-
getLocalRepositoryConnector
Return the connector to the local repository.- Returns:
- OMRSRepositoryConnector
-
setLocalRepositoryConnector
Set up the connector to the local repository.- Parameters:
localRepositoryConnector
- access to the local repository (updated to generate events for the technology under test to respond to)
-
getProfileNames
Accumulate the set of profile names registered with this work pad.- Specified by:
getProfileNames
in classOpenMetadataConformanceWorkbenchWorkPad
- Returns:
- the profile names
-
getProfileResults
Accumulate the evidences for a given profile.- Specified by:
getProfileResults
in classOpenMetadataConformanceWorkbenchWorkPad
- Parameters:
profileName
- for which to obtain the detailed results- Returns:
- the test evidence organized by profile and requirement within profile
-
getProfileResults
Accumulate the evidences for each profile- Specified by:
getProfileResults
in classOpenMetadataConformanceWorkbenchWorkPad
- Returns:
- the test evidence organized by profile and requirement withing profile
-
getProfileSummaries
Accumulate the summarized evidences for each profile- Specified by:
getProfileSummaries
in classOpenMetadataConformanceWorkbenchWorkPad
- Returns:
- the summarized test evidence organized by profile and requirement withing profile
-
getEntitySubTypes
Return the list of subtypes of the named entity type- Parameters:
entityTypeName
- - the name of the entity type- Returns:
- - the list of subtypes of the entity type
-
getRelationshipSubTypes
Return the list of subtypes of the named relationship type- Parameters:
relationshipTypeName
- - the name of the relationship type- Returns:
- - the list of subtypes of the relationship type
-
getEntityRelationshipTypes
Return the list of end types for the named relationship type.- Parameters:
entityTypeName
- requested type- Returns:
- list of relationship types for the entity type
-
getEntityTypeNames
Return the set of supported entity type names- Returns:
- list of type names
-
getRelationshipEndTypes
Return the list of end types for the named relationship type- Parameters:
relationshipTypeName
- relationship type- Returns:
- list of end types
-
getRelationshipTypeNames
Return the set of supported relationship type names- Returns:
- list of relationship types
-
addEntityInstanceSets
public void addEntityInstanceSets(String entityTypeName, List<EntityDetail> set_0, List<EntityDetail> set_1, List<EntityDetail> set_2) Remember the sets of instances for a given entity type. This is to support- Parameters:
entityTypeName
- - name of entity typeset_0
- - a list of entitiesset_1
- - a list of entitiesset_2
- - a list of entities
-
getEntityInstanceSet
Retrieve entity instances for the given type for the given instance set- Parameters:
entityTypeName
- entity type namesetId
- which set- Returns:
- list of entities
-
removeEntityInstanceSets
Clean up entity instances for the given type.- Parameters:
entityTypeName
- name of entity type
-
addRelationshipInstanceSets
public void addRelationshipInstanceSets(String relationshipTypeName, List<Relationship> set_0, List<Relationship> set_1, List<Relationship> set_2) Remember the sets of instances for a given relationship type. This is to support- Parameters:
relationshipTypeName
- - type name for relationshipset_0
- - a list of relationshipsset_1
- - a list of relationshipsset_2
- - a list of relationships
-
getRelationshipInstanceSet
Retrieve relationship instances for the given type for the given instance set- Parameters:
relationshipTypeName
- relationship type namesetId
- which set?- Returns:
- list of relationships
-
removeRelationshipInstanceSets
Clean up relationship instances for the given type.- Parameters:
relationshipTypeName
- relationship type name
-
toString
toString() JSON-style- Overrides:
toString
in classOpenMetadataConformanceWorkbenchWorkPad
- Returns:
- string description
-