SecuritySyncConfig (Administration Services API 1.0 API)

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

All Implemented Interfaces:

Serializable
```
public class SecuritySyncConfig
extends AdminServicesConfigHeader
```
SecuritySyncConfig provides the properties for the security-sync-services.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SecuritySyncConfig()
Default constructor

SecuritySyncConfig(SecuritySyncConfig template)
Set up the default values for security sync

Constructors
Constructor and Description
`SecuritySyncConfig()` Default constructor
`SecuritySyncConfig(SecuritySyncConfig template)` Set up the default values for security sync

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`	`getGovernanceEngineServerURL()` Return the URL for the Governance Engine Server used in the Governance Server Connector
`String`	`getSecurityServerAuthorization()` Return the authorization needed in the Governance Services Connector
`String`	`getSecurityServerType()` Return the server type in order to identify the Governance Connector.
`String`	`getSecurityServerURL()` Return the URL for the Security Server used in the Governance Server Connector
`String`	`getSecuritySyncDescription()` Return the short description of the Security Sync Component.
`int`	`getSecuritySyncId()` Return the code number (ordinal) for this Security Sync
`Connection`	`getSecuritySyncInTopic()` Return the OCF Connection for the In Topic used to pass requests to this Security Sync.
`String`	`getSecuritySyncInTopicName()` Return the Input Topic Name for Security Sync
`String`	`getSecuritySyncName()` Return the name of the Security Sync Connector
`Connection`	`getSecuritySyncOutTopic()` Return the OCF Connection for the topic used to pass requests to Security Sync.
`String`	`getSecuritySyncOutTopicName()` Return the Security Sync Out Topic Name
`String`	`getSecuritySyncWiki()` Return the wiki page link for the Security Sync.
`String`	`getTagServiceName()` Return the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setGovernanceEngineServerURL(String governanceEngineServerURL)` Set up the URL for the Governance Engine Server used in the Governance Server Connector.
`void`	`setSecurityServerAuthorization(String securityServerAuthorization)` Set up the authorization needed in the Governance Services Connector.
`void`	`setSecurityServerType(String securityServerType)` Set up the server type in order to identify the Governance Connector.
`void`	`setSecurityServerURL(String securityServerURL)` Set up the URL for the Security Server used in the Governance Server Connector.
`void`	`setSecuritySyncDescription(String securitySyncDescription)` Set up the short description of the Security Sync.
`void`	`setSecuritySyncId(int securitySyncId)` Set up the code number (ordinal) for the Security Sync
`void`	`setSecuritySyncInTopic(Connection securitySyncInTopic)` Set up the OCF Connection for the Out Topic used to pass requests to this Security Sync.
`void`	`setSecuritySyncInTopicName(String securitySyncInTopicName)` Set up the Security Sync In Topic Name
`void`	`setSecuritySyncName(String securitySyncName)` Set up the name of the Security Sync Connector
`void`	`setSecuritySyncOutTopic(Connection securitySyncOutTopic)` Set up the OCF Connection for the Out Topic used to pass requests to this Security Sync.
`void`	`setSecuritySyncOutTopicName(String securitySyncOutTopicName)` Set up the Security Sync Out Name
`void`	`setSecuritySyncWiki(String securitySyncWiki)` Set up the wiki page link for the Security Sync.
`void`	`setTagServiceName(String tagServiceName)` Set up the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
`String`	`toString()`

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

- Constructor Detail
  - SecuritySyncConfig
```
public SecuritySyncConfig()
```
    Default constructor
  - SecuritySyncConfig
```
public SecuritySyncConfig(SecuritySyncConfig template)
```
    Set up the default values for security sync
    
    Parameters:
    
    template - fixed properties about security sync
- Method Detail
  - getSecuritySyncId
```
public int getSecuritySyncId()
```
    Return the code number (ordinal) for this Security Sync
    
    Returns:
    
    the code numner for Security Sync component
  - setSecuritySyncId
```
public void setSecuritySyncId(int securitySyncId)
```
    Set up the code number (ordinal) for the Security Sync
    
    Parameters:
    
    securitySyncId - int ordinal
  - getSecuritySyncName
```
public String getSecuritySyncName()
```
    Return the name of the Security Sync Connector
    
    Returns:
    
    the name of the security sync connector
  - setSecuritySyncName
```
public void setSecuritySyncName(String securitySyncName)
```
    Set up the name of the Security Sync Connector
    
    Parameters:
    
    securitySyncName - connector name
  - getSecuritySyncDescription
```
public String getSecuritySyncDescription()
```
    Return the short description of the Security Sync Component. The default value is in English but this can be changed.
    
    Returns:
    
    String description
  - setSecuritySyncDescription
```
public void setSecuritySyncDescription(String securitySyncDescription)
```
    Set up the short description of the Security Sync.
    
    Parameters:
    
    securitySyncDescription - String description
  - getSecuritySyncWiki
```
public String getSecuritySyncWiki()
```
    Return the wiki page link for the Security Sync. The default value points to a page on the Egeria confluence wiki.
    
    Returns:
    
    String url
  - setSecuritySyncWiki
```
public void setSecuritySyncWiki(String securitySyncWiki)
```
    Set up the wiki page link for the Security Sync. The default value points to a page on the Egeria confluence wiki.
    
    Parameters:
    
    securitySyncWiki - String url
  - getSecurityServerURL
```
public String getSecurityServerURL()
```
    Return the URL for the Security Server used in the Governance Server Connector
    
    Returns:
    
    String URL
  - setSecurityServerURL
```
public void setSecurityServerURL(String securityServerURL)
```
    Set up the URL for the Security Server used in the Governance Server Connector.
    
    Parameters:
    
    securityServerURL - String for Governance Server URL
  - getGovernanceEngineServerURL
```
public String getGovernanceEngineServerURL()
```
    Return the URL for the Governance Engine Server used in the Governance Server Connector
    
    Returns:
    
    String URL
  - setGovernanceEngineServerURL
```
public void setGovernanceEngineServerURL(String governanceEngineServerURL)
```
    Set up the URL for the Governance Engine Server used in the Governance Server Connector.
    
    Parameters:
    
    governanceEngineServerURL - String for Governance Server URL
  - getSecurityServerType
```
public String getSecurityServerType()
```
    Return the server type in order to identify the Governance Connector.
    
    Returns:
    
    String Server type
  - setSecurityServerType
```
public void setSecurityServerType(String securityServerType)
```
    Set up the server type in order to identify the Governance Connector.
    
    Parameters:
    
    securityServerType - String
  - getSecurityServerAuthorization
```
public String getSecurityServerAuthorization()
```
    Return the authorization needed in the Governance Services Connector
    
    Returns:
    
    String with basic authorization header
  - setSecurityServerAuthorization
```
public void setSecurityServerAuthorization(String securityServerAuthorization)
```
    Set up the authorization needed in the Governance Services Connector.
    
    Parameters:
    
    securityServerAuthorization - String with basic authorization header
  - getTagServiceName
```
public String getTagServiceName()
```
    Return the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
    
    Returns:
    
    String tag service name
  - setTagServiceName
```
public void setTagServiceName(String tagServiceName)
```
    Set up the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
    
    Parameters:
    
    tagServiceName - the name of the tag service
  - getSecuritySyncInTopicName
```
public String getSecuritySyncInTopicName()
```
    Return the Input Topic Name for Security Sync
    
    Returns:
    
    String Input Topic name
  - setSecuritySyncInTopicName
```
public void setSecuritySyncInTopicName(String securitySyncInTopicName)
```
    Set up the Security Sync In Topic Name
    
    Parameters:
    
    securitySyncInTopicName - String Security Sync Name
  - getSecuritySyncInTopic
```
public Connection getSecuritySyncInTopic()
```
    Return the OCF Connection for the In Topic used to pass requests to this Security Sync. For example, the output topic of Governance Engine OMAS can be provided (e.g. "open-metadata.access-services.GovernanceEngine.outTopic")
    
    Returns:
    
    Connection for In Topic
  - setSecuritySyncInTopic
```
public void setSecuritySyncInTopic(Connection securitySyncInTopic)
```
    Set up the OCF Connection for the Out Topic used to pass requests to this Security Sync.
    
    Parameters:
    
    securitySyncInTopic - Connection for In Topic
  - getSecuritySyncOutTopicName
```
public String getSecuritySyncOutTopicName()
```
    Return the Security Sync Out Topic Name
    
    Returns:
    
    String security out topic name
  - setSecuritySyncOutTopicName
```
public void setSecuritySyncOutTopicName(String securitySyncOutTopicName)
```
    Set up the Security Sync Out Name
    
    Parameters:
    
    securitySyncOutTopicName - String Security Out Topic Name
  - getSecuritySyncOutTopic
```
public Connection getSecuritySyncOutTopic()
```
    Return the OCF Connection for the topic used to pass requests to Security Sync. The default values are constructed from the Security Sync Server Name.
    
    Returns:
    
    Connection for Out Topic
  - setSecuritySyncOutTopic
```
public void setSecuritySyncOutTopic(Connection securitySyncOutTopic)
```
    Set up the OCF Connection for the Out Topic used to pass requests to this Security Sync.
    
    Parameters:
    
    securitySyncOutTopic - Connection for Out Topic
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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 SecuritySyncConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecuritySyncConfig

SecuritySyncConfig

Method Detail

getSecuritySyncId

setSecuritySyncId

getSecuritySyncName

setSecuritySyncName

getSecuritySyncDescription

setSecuritySyncDescription

getSecuritySyncWiki

setSecuritySyncWiki

getSecurityServerURL

setSecurityServerURL

getGovernanceEngineServerURL

setGovernanceEngineServerURL

getSecurityServerType

setSecurityServerType

getSecurityServerAuthorization

setSecurityServerAuthorization

getTagServiceName

setTagServiceName

getSecuritySyncInTopicName

setSecuritySyncInTopicName

getSecuritySyncInTopic

setSecuritySyncInTopic

getSecuritySyncOutTopicName

setSecuritySyncOutTopicName

getSecuritySyncOutTopic

setSecuritySyncOutTopic

toString

equals

hashCode