AccessServiceConfig (Administration Services API 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
- - org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig

All Implemented Interfaces:

Serializable
```
public class AccessServiceConfig
extends AdminServicesConfigHeader
```
AccessServiceConfig provides the configuration for a single Open Metadata Access Service (OMAS).

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AccessServiceConfig()` Default constructor for use with Jackson libraries
`AccessServiceConfig(AccessServiceConfig template)` Copy/clone constructor
`AccessServiceConfig(AccessServiceRegistration accessServiceRegistration)` Set up the default values for an access service using an access service description.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Validate that an object is equal depending on their stored values.
`String`	`getAccessServiceAdminClass()` Return the Java class name of the admin-services interface for this access service.
`String`	`getAccessServiceDescription()` Return the short description of the access service.
`int`	`getAccessServiceId()` Return the code number (ordinal) for this access service.
`Connection`	`getAccessServiceInTopic()` Return the OCF Connection for the topic used to pass requests to this access service.
`String`	`getAccessServiceName()` Return the name of the access service.
`AccessServiceOperationalStatus`	`getAccessServiceOperationalStatus()` Return the status of this access service.
`Map<String,Object>`	`getAccessServiceOptions()` Return the options for this access service.
`Connection`	`getAccessServiceOutTopic()` Return the OCF Connection for the topic used by this access service to publish events.
`String`	`getAccessServiceWiki()` Return the wiki page link for the access service.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setAccessServiceAdminClass(String accessServiceAdminClass)` Set up the Java class name of the admin services interface for this access service.
`void`	`setAccessServiceDescription(String accessServiceDescription)` Set up the short description of the access service.
`void`	`setAccessServiceId(int accessServiceId)` Set up the code number (ordinal) for this access service.
`void`	`setAccessServiceInTopic(Connection accessServiceInTopic)` Set up the OCF Connection for the topic used to pass requests to this access service.
`void`	`setAccessServiceName(String accessServiceName)` Set up the name of the access service.
`void`	`setAccessServiceOperationalStatus(AccessServiceOperationalStatus accessServiceOperationalStatus)` Set up the status of the access service.
`void`	`setAccessServiceOptions(Map<String,Object> accessServiceOptions)` Set up the options for this access service.
`void`	`setAccessServiceOutTopic(Connection accessServiceOutTopic)` Set up the OCF Connection of the topic used by this access service to publish events.
`void`	`setAccessServiceWiki(String accessServiceWiki)` Set up the wiki page link for the access service.
`String`	`toString()` Standard toString method.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AccessServiceConfig
```
public AccessServiceConfig()
```
    Default constructor for use with Jackson libraries
  - AccessServiceConfig
```
public AccessServiceConfig(AccessServiceConfig template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
  - AccessServiceConfig
```
public AccessServiceConfig(AccessServiceRegistration accessServiceRegistration)
```
    Set up the default values for an access service using an access service description.
    
    Parameters:
    
    accessServiceRegistration - fixed properties about the access service
- Method Detail
  - getAccessServiceId
```
public int getAccessServiceId()
```
    Return the code number (ordinal) for this access service.
    
    Returns:
    
    int ordinal
  - setAccessServiceId
```
public void setAccessServiceId(int accessServiceId)
```
    Set up the code number (ordinal) for this access service.
    
    Parameters:
    
    accessServiceId - int ordinal
  - getAccessServiceAdminClass
```
public String getAccessServiceAdminClass()
```
    Return the Java class name of the admin-services interface for this access service.
    
    Returns:
    
    String class name implementing the AccessServiceAdmin interface.
  - setAccessServiceAdminClass
```
public void setAccessServiceAdminClass(String accessServiceAdminClass)
```
    Set up the Java class name of the admin services interface for this access service.
    
    Parameters:
    
    accessServiceAdminClass - String class name implementing the AccessServiceAdmin interface.
  - getAccessServiceName
```
public String getAccessServiceName()
```
    Return the name of the access service.
    
    Returns:
    
    String name
  - setAccessServiceName
```
public void setAccessServiceName(String accessServiceName)
```
    Set up the name of the access service.
    
    Parameters:
    
    accessServiceName - String name
  - getAccessServiceDescription
```
public String getAccessServiceDescription()
```
    Return the short description of the access service. The default value is in English but this can be changed.
    
    Returns:
    
    String description
  - setAccessServiceDescription
```
public void setAccessServiceDescription(String accessServiceDescription)
```
    Set up the short description of the access service.
    
    Parameters:
    
    accessServiceDescription - String description
  - getAccessServiceWiki
```
public String getAccessServiceWiki()
```
    Return the wiki page link for the access service. The default value points to a page on the Atlas confluence wiki.
    
    Returns:
    
    String url
  - setAccessServiceWiki
```
public void setAccessServiceWiki(String accessServiceWiki)
```
    Set up the wiki page link for the access service.
    
    Parameters:
    
    accessServiceWiki - String url
  - getAccessServiceOperationalStatus
```
public AccessServiceOperationalStatus getAccessServiceOperationalStatus()
```
    Return the status of this access service.
    
    Returns:
    
    AccessServiceOperationalStatus enum
  - setAccessServiceOperationalStatus
```
public void setAccessServiceOperationalStatus(AccessServiceOperationalStatus accessServiceOperationalStatus)
```
    Set up the status of the access service.
    
    Parameters:
    
    accessServiceOperationalStatus - AccessServiceOperationalStatus enum
  - getAccessServiceInTopic
```
public Connection getAccessServiceInTopic()
```
    Return the OCF Connection for the topic used to pass requests to this access service. The default values are constructed from the access service name. If this value is set to null then the access service ignores incoming events.
    
    Returns:
    
    Connection for InTopic
  - setAccessServiceInTopic
```
public void setAccessServiceInTopic(Connection accessServiceInTopic)
```
    Set up the OCF Connection for the topic used to pass requests to this access service. The default values are constructed from the access service name. If this value is set to null then the access service ignores incoming events.
    
    Parameters:
    
    accessServiceInTopic - Connection properties
  - getAccessServiceOutTopic
```
public Connection getAccessServiceOutTopic()
```
    Return the OCF Connection for the topic used by this access service to publish events. The default values are constructed from the access service name. If this value is set to null then events are not published by this OMAS.
    
    Returns:
    
    Connection for OutTopic
  - setAccessServiceOutTopic
```
public void setAccessServiceOutTopic(Connection accessServiceOutTopic)
```
    Set up the OCF Connection of the topic used by this access service to publish events. The default values are constructed from the access service name. If this value is set to null then events are not published by this OMAS.
    
    Parameters:
    
    accessServiceOutTopic - Connection properties
  - getAccessServiceOptions
```
public Map<String,Object> getAccessServiceOptions()
```
    Return the options for this access service. These are properties that are specific to the access service.
    
    Returns:
    
    Map from String to String
  - setAccessServiceOptions
```
public void setAccessServiceOptions(Map<String,Object> accessServiceOptions)
```
    Set up the options for this access service. These are properties that are specific to the access service.
    
    Parameters:
    
    accessServiceOptions - Map from String to String
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSON style description of variables.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Validate that an object is equal depending on their stored values.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - object
    
    Returns:
    
    boolean result
  - hashCode
```
public int hashCode()
```
    Return a hash code based on the values of this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    in hash code

Class AccessServiceConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessServiceConfig

AccessServiceConfig

AccessServiceConfig

Method Detail

getAccessServiceId

setAccessServiceId

getAccessServiceAdminClass

setAccessServiceAdminClass

getAccessServiceName

setAccessServiceName

getAccessServiceDescription

setAccessServiceDescription

getAccessServiceWiki

setAccessServiceWiki

getAccessServiceOperationalStatus

setAccessServiceOperationalStatus

getAccessServiceInTopic

setAccessServiceInTopic

getAccessServiceOutTopic

setAccessServiceOutTopic

getAccessServiceOptions

setAccessServiceOptions

toString

equals

hashCode