SecuritySyncConfig (Administration Services API 2.2 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`	`getAccessServiceRootURL()` Return the URL for the Governance Engine Server used in the Governance Server Connector
`String`	`getAccessServiceServerName()` Return the name of the server where Governance Engine OMAS is running
`Long`	`getPollingInterval()`
`String`	`getSecurityServerURL()` Return the URL for the Security Server used in the Governance Server Connector
`String`	`getSecuritySyncAccessResourceServiceName()` Return the Access Resource Service Named used in the Governance Services Connector to synchronize the access resource policies.
`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
`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`	`getSecuritySyncServerAuthorization()` Return the authorization needed in the Governance Services Connector
`Connection`	`getSecuritySyncServerConnection()` Return the OCF Connection for the Security Server used to push the Security Tags.
`String`	`getSecuritySyncServerType()` Return the server type in order to identify the Governance Connector.
`String`	`getSecuritySyncTagServiceName()` 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`	`setAccessServiceRootURL(String accessServiceRootURL)` Set up the URL for the Governance Engine Server used in the Governance Server Connector.
`void`	`setAccessServiceServerName(String accessServiceServerName)` Set up the name of the server where Governance Engine OMAS is running
`void`	`setPollingInterval(Long pollingInterval)` Set up the polling interval in milli seconds
`void`	`setSecurityServerURL(String securityServerURL)` Set up the URL for the Security Server used in the Governance Server Connector.
`void`	`setSecuritySyncAccessResourceServiceName(String securitySyncAccessResourceServiceName)` Set up the Access Resource Service Named used in the Governance Services Connector to synchronize the access resource policies.
`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`	`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`	`setSecuritySyncServerAuthorization(String securitySyncServerAuthorization)` Set up the authorization needed in the Governance Services Connector.
`void`	`setSecuritySyncServerConnection(Connection securitySyncServerConnection)` Set up the OCF Connection for the Security Server used to pass requests to this Security Sync.
`void`	`setSecuritySyncServerType(String securitySyncServerType)` Set up the server type in order to identify the Governance Connector.
`void`	`setSecuritySyncTagServiceName(String securitySyncTagServiceName)` 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
  - 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
  - getAccessServiceRootURL
```
public String getAccessServiceRootURL()
```
    Return the URL for the Governance Engine Server used in the Governance Server Connector
    
    Returns:
    
    String URL
  - setAccessServiceRootURL
```
public void setAccessServiceRootURL(String accessServiceRootURL)
```
    Set up the URL for the Governance Engine Server used in the Governance Server Connector.
    
    Parameters:
    
    accessServiceRootURL - String for Governance Server URL
  - getAccessServiceServerName
```
public String getAccessServiceServerName()
```
    Return the name of the server where Governance Engine OMAS is running
    
    Returns:
    
    string name
  - setAccessServiceServerName
```
public void setAccessServiceServerName(String accessServiceServerName)
```
    Set up the name of the server where Governance Engine OMAS is running
    
    Parameters:
    
    accessServiceServerName - string name
  - getSecuritySyncServerType
```
public String getSecuritySyncServerType()
```
    Return the server type in order to identify the Governance Connector.
    
    Returns:
    
    String Server type
  - setSecuritySyncServerType
```
public void setSecuritySyncServerType(String securitySyncServerType)
```
    Set up the server type in order to identify the Governance Connector.
    
    Parameters:
    
    securitySyncServerType - String
  - getSecuritySyncServerAuthorization
```
public String getSecuritySyncServerAuthorization()
```
    Return the authorization needed in the Governance Services Connector
    
    Returns:
    
    String with basic authorization header
  - setSecuritySyncServerAuthorization
```
public void setSecuritySyncServerAuthorization(String securitySyncServerAuthorization)
```
    Set up the authorization needed in the Governance Services Connector.
    
    Parameters:
    
    securitySyncServerAuthorization - String with basic authorization header
  - getSecuritySyncTagServiceName
```
public String getSecuritySyncTagServiceName()
```
    Return the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
    
    Returns:
    
    String tag service name
  - setSecuritySyncTagServiceName
```
public void setSecuritySyncTagServiceName(String securitySyncTagServiceName)
```
    Set up the Tag Service Named used in the Governance Services Connector to synchronize the governed classifications.
    
    Parameters:
    
    securitySyncTagServiceName - the name of the tag service
  - getSecuritySyncAccessResourceServiceName
```
public String getSecuritySyncAccessResourceServiceName()
```
    Return the Access Resource Service Named used in the Governance Services Connector to synchronize the access resource policies.
    
    Returns:
    
    Resource access based policies
  - setSecuritySyncAccessResourceServiceName
```
public void setSecuritySyncAccessResourceServiceName(String securitySyncAccessResourceServiceName)
```
    Set up the Access Resource Service Named used in the Governance Services Connector to synchronize the access resource policies.
    
    Parameters:
    
    securitySyncAccessResourceServiceName - string name
  - getPollingInterval
```
public Long getPollingInterval()
```
    Returns:
    
    the polling interval in milli seconds
  - setPollingInterval
```
public void setPollingInterval(Long pollingInterval)
```
    Set up the polling interval in milli seconds
    
    Parameters:
    
    pollingInterval - polling interval in milli seconds
  - 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. "omas.accessservices.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
  - getSecuritySyncServerConnection
```
public Connection getSecuritySyncServerConnection()
```
    Return the OCF Connection for the Security Server used to push the Security Tags.
    
    Returns:
    
    Connection for Security Server
  - setSecuritySyncServerConnection
```
public void setSecuritySyncServerConnection(Connection securitySyncServerConnection)
```
    Set up the OCF Connection for the Security Server used to pass requests to this Security Sync.
    
    Parameters:
    
    securitySyncServerConnection - Connection for Security Server
  - 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

getSecurityServerURL

setSecurityServerURL

getAccessServiceRootURL

setAccessServiceRootURL

getAccessServiceServerName

setAccessServiceServerName

getSecuritySyncServerType

setSecuritySyncServerType

getSecuritySyncServerAuthorization

setSecuritySyncServerAuthorization

getSecuritySyncTagServiceName

setSecuritySyncTagServiceName

getSecuritySyncAccessResourceServiceName

setSecuritySyncAccessResourceServiceName

getPollingInterval

setPollingInterval

getSecuritySyncInTopicName

setSecuritySyncInTopicName

getSecuritySyncInTopic

setSecuritySyncInTopic

getSecuritySyncOutTopicName

setSecuritySyncOutTopicName

getSecuritySyncOutTopic

setSecuritySyncOutTopic

getSecuritySyncServerConnection

setSecuritySyncServerConnection

toString

equals

hashCode