org.apache.ambari.server.state

Class SingleSignOnInfo

java.lang.Object

org.apache.ambari.server.state.SingleSignOnInfo

public class SingleSignOnInfo
extends Object

SingleSignOnInfo encapsulates meta information about a service's support for single sign-on (SSO) integration

The data is expected to be like

   <sso>
     <supported>true</supported>
     <ssoEnabledTest>
         {
           "equals": [
             "config-type/sso.enabled.property_name",
             "true"
           ]
         }
     </ssoEnabledTest>
   </sso>
 

Constructor Summary

Constructors

Constructor and Description
SingleSignOnInfo() Default constructor
SingleSignOnInfo(Boolean supported, String enabledConfiguration, Boolean kerberosRequired) Constructor taking in values for supported and the configuration that can be used to determine if it is enabled for not.

Method Summary

Modifier and Type	Method and Description
String	getEnabledConfiguration() Deprecated. USe getSsoEnabledTest() instead Gets the configuration specification that can be used to determine if SSO has been enabled or not.
String	getSsoEnabledTest() Gets the configuration specification that can be used to determine if SSO has been enabled or not.
Boolean	getSupported() Gets the value whether if the service supports SSO integration.
boolean	isKerberosRequired()
boolean	isSupported() Tests whether the service supports SSO integration.
void	setEnabledConfiguration(String enabledConfiguration) Deprecated. Use setSsoEnabledTest(String) instead Sets the configuration specification that can be used to determine if SSO has been enabled or not.
void	setKerberosRequired(Boolean kerberosRequired) Sets the flag is Kerberos is required for SSO integration
void	setSsoEnabledTest(String ssoEnabledTest) Sets the configuration specification that can be used to determine if SSO has been enabled or not.
void	setSupported(Boolean supported) Gets the value indicating whether the service supports SSO integration.
String	toString() String representation of this object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleSignOnInfo

public SingleSignOnInfo()

Default constructor

SingleSignOnInfo

public SingleSignOnInfo(Boolean supported,
                        String enabledConfiguration,
                        Boolean kerberosRequired)

Constructor taking in values for supported and the configuration that can be used to determine if it is enabled for not.

Parameters:

supported - true if SSO integration is supported; false otherwise

enabledConfiguration - the configuration that can be used to determine if SSO integration has been enabled

kerberosRequired - true if Kerberos is required for SSO integration; false otherwise

Method Detail

isSupported

public boolean isSupported()

Tests whether the service supports SSO integration.

Returns:

true if SSO integration is supported; false otherwise

getSupported

public Boolean getSupported()

Gets the value whether if the service supports SSO integration.

null indicates the value was not set

Returns:

true if SSO integration is supported; false if SSO integration is not supported; null if not specified

setSupported

public void setSupported(Boolean supported)

Gets the value indicating whether the service supports SSO integration.

Parameters:

supported - true if SSO integration is supported; false if SSO integration is not supported; null if not specified

getEnabledConfiguration

public String getEnabledConfiguration()

Deprecated. USe getSsoEnabledTest() instead

Gets the configuration specification that can be used to determine if SSO has been enabled or not.

Returns:

a configuration specification (config-type/property_name)

setEnabledConfiguration

public void setEnabledConfiguration(String enabledConfiguration)

Deprecated. Use setSsoEnabledTest(String) instead

Sets the configuration specification that can be used to determine if SSO has been enabled or not.

Parameters:

enabledConfiguration - a configuration specification (config-type/property_name)

getSsoEnabledTest

public String getSsoEnabledTest()

Gets the configuration specification that can be used to determine if SSO has been enabled or not.

Returns:

a configuration specification (a valid JSON predicate)

setSsoEnabledTest

public void setSsoEnabledTest(String ssoEnabledTest)

Sets the configuration specification that can be used to determine if SSO has been enabled or not.

Parameters:

enabledConfiguration - a configuration specification (a valid JSON predicate)

isKerberosRequired

public boolean isKerberosRequired()

Returns:

the flag is Kerberos is required for SSO integration

setKerberosRequired

public void setKerberosRequired(Boolean kerberosRequired)

Sets the flag is Kerberos is required for SSO integration

toString

public String toString()

String representation of this object

Overrides:

toString in class Object

Returns:

a string