Class ViewServiceConfig
- java.lang.Object
-
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
-
- org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
-
- org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
IntegrationViewServiceConfig
,SolutionViewServiceConfig
public class ViewServiceConfig extends OMAGServerClientConfig
ViewServiceConfig provides the configuration for a single Open Metadata View Service (OMVS).- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ViewServiceConfig()
Default constructor for use with Jackson librariesViewServiceConfig(ViewServiceConfig template)
Copy/clone constructorViewServiceConfig(ViewServiceRegistrationEntry viewRegistration)
Set up the default values for a view service using a view service description.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object objectToCompare)
Validate that an object is equal depending on their stored values.java.lang.String
getViewServiceAdminClass()
Return the Java class name of the admin-services interface for this view service.java.lang.String
getViewServiceDescription()
Return the short description of the view service.ComponentDevelopmentStatus
getViewServiceDevelopmentStatus()
Return the development status of the service.java.lang.String
getViewServiceFullName()
Return the full name of the view service.int
getViewServiceId()
Return the code number (ordinal) for this view service.java.lang.String
getViewServiceName()
Return the name of the view service.ServiceOperationalStatus
getViewServiceOperationalStatus()
Return the status of this view service.java.util.Map<java.lang.String,java.lang.Object>
getViewServiceOptions()
Return the options for this view service.java.lang.String
getViewServiceURLMarker()
Return the string that appears in the REST API URL that identifies the owning service.java.lang.String
getViewServiceWiki()
Return the wiki page link for the view service.int
hashCode()
Return a hash code based on the values of this object.void
setViewServiceAdminClass(java.lang.String viewServiceAdminClass)
Set up the Java class name of the admin services interface for this view service.void
setViewServiceDescription(java.lang.String viewServiceDescription)
Set up the short description of the view service.void
setViewServiceDevelopmentStatus(ComponentDevelopmentStatus viewServiceDevelopmentStatus)
Set up the development status of the service.void
setViewServiceFullName(java.lang.String viewServiceFullName)
Set up the full name of the view service.void
setViewServiceId(int viewId)
Set up the code number (ordinal) for this view service.void
setViewServiceName(java.lang.String viewServiceName)
Set up the name of the view service.void
setViewServiceOperationalStatus(ServiceOperationalStatus viewServiceOperationalStatus)
Set up the status of the view service.void
setViewServiceOptions(java.util.Map<java.lang.String,java.lang.Object> viewServiceOptions)
Set up the options for this view service.void
setViewServiceURLMarker(java.lang.String viewServiceURLMarker)
Set up the string that appears in the REST API URL that identifies the owning service.void
setViewServiceWiki(java.lang.String viewServiceWiki)
Set up the wiki page link for the view service.java.lang.String
toString()
Standard toString method.-
Methods inherited from class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
getOMAGServerName, getOMAGServerPlatformRootURL, setOMAGServerName, setOMAGServerPlatformRootURL
-
-
-
-
Constructor Detail
-
ViewServiceConfig
public ViewServiceConfig()
Default constructor for use with Jackson libraries
-
ViewServiceConfig
public ViewServiceConfig(ViewServiceConfig template)
Copy/clone constructor- Parameters:
template
- object to copy
-
ViewServiceConfig
public ViewServiceConfig(ViewServiceRegistrationEntry viewRegistration)
Set up the default values for a view service using a view service description.- Parameters:
viewRegistration
- fixed properties about the view service
-
-
Method Detail
-
getViewServiceId
public int getViewServiceId()
Return the code number (ordinal) for this view service.- Returns:
- int ordinal
-
setViewServiceId
public void setViewServiceId(int viewId)
Set up the code number (ordinal) for this view service.- Parameters:
viewId
- int ordinal
-
getViewServiceDevelopmentStatus
public ComponentDevelopmentStatus getViewServiceDevelopmentStatus()
Return the development status of the service.- Returns:
- enum describing the status
-
setViewServiceDevelopmentStatus
public void setViewServiceDevelopmentStatus(ComponentDevelopmentStatus viewServiceDevelopmentStatus)
Set up the development status of the service.- Parameters:
viewServiceDevelopmentStatus
- enum describing the status
-
getViewServiceAdminClass
public java.lang.String getViewServiceAdminClass()
Return the Java class name of the admin-services interface for this view service.- Returns:
- String class name implementing the ViewServiceAdmin interface.
-
setViewServiceAdminClass
public void setViewServiceAdminClass(java.lang.String viewServiceAdminClass)
Set up the Java class name of the admin services interface for this view service.- Parameters:
viewServiceAdminClass
- String class name implementing the ViewServiceAdmin interface.
-
getViewServiceFullName
public java.lang.String getViewServiceFullName()
Return the full name of the view service.- Returns:
- String name
-
setViewServiceFullName
public void setViewServiceFullName(java.lang.String viewServiceFullName)
Set up the full name of the view service.- Parameters:
viewServiceFullName
- String name
-
getViewServiceName
public java.lang.String getViewServiceName()
Return the name of the view service.- Returns:
- String name
-
setViewServiceName
public void setViewServiceName(java.lang.String viewServiceName)
Set up the name of the view service.- Parameters:
viewServiceName
- String name
-
getViewServiceURLMarker
public java.lang.String getViewServiceURLMarker()
Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.- Returns:
- String viewServiceURLMarker
-
setViewServiceURLMarker
public void setViewServiceURLMarker(java.lang.String viewServiceURLMarker)
Set up the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.- Parameters:
viewServiceURLMarker
- url fragment
-
getViewServiceDescription
public java.lang.String getViewServiceDescription()
Return the short description of the view service. The default value is in English but this can be changed.- Returns:
- String viewServiceDescription
-
setViewServiceDescription
public void setViewServiceDescription(java.lang.String viewServiceDescription)
Set up the short description of the view service.- Parameters:
viewServiceDescription
- String description
-
getViewServiceWiki
public java.lang.String getViewServiceWiki()
Return the wiki page link for the view service.- Returns:
- viewServiceWiki String url
-
setViewServiceWiki
public void setViewServiceWiki(java.lang.String viewServiceWiki)
Set up the wiki page link for the view service.- Parameters:
viewServiceWiki
- String url
-
getViewServiceOperationalStatus
public ServiceOperationalStatus getViewServiceOperationalStatus()
Return the status of this view service.- Returns:
- viewServiceOperationalStatus enum
-
setViewServiceOperationalStatus
public void setViewServiceOperationalStatus(ServiceOperationalStatus viewServiceOperationalStatus)
Set up the status of the view service.- Parameters:
viewServiceOperationalStatus
- ViewServiceOperationalStatus enum
-
getViewServiceOptions
public java.util.Map<java.lang.String,java.lang.Object> getViewServiceOptions()
Return the options for this view service. These are properties that are specific to the view service.- Returns:
- Map from String to String
-
setViewServiceOptions
public void setViewServiceOptions(java.util.Map<java.lang.String,java.lang.Object> viewServiceOptions)
Set up the options for this view service. These are properties that are specific to the view service.- Parameters:
viewServiceOptions
- Map from String to String
-
toString
public java.lang.String toString()
Standard toString method.- Overrides:
toString
in classOMAGServerClientConfig
- Returns:
- JSON style description of variables.
-
equals
public boolean equals(java.lang.Object objectToCompare)
Validate that an object is equal depending on their stored values.- Overrides:
equals
in classOMAGServerClientConfig
- Parameters:
objectToCompare
- object- Returns:
- boolean result
-
hashCode
public int hashCode()
Return a hash code based on the values of this object.- Overrides:
hashCode
in classOMAGServerClientConfig
- Returns:
- in hash code
-
-