SocialAuthenticationImplementation (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- org.forgerock.openam.core.rest.server.SocialAuthenticationImplementation

public final class SocialAuthenticationImplementation
extends Object

A class to encapsulate a social authentication implementation.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CHAINS_ATTRIBUTE`
`static String`	`DISPLAY_NAME_ATTRIBUTE`
`static String`	`ENABLED_IMPLEMENTATIONS_ATTRIBUTE`
`static String`	`ICONS_ATTRIBUTE`
`static String`	`SERVICE_NAME`

Constructor Summary

Constructors
Constructor Description

SocialAuthenticationImplementation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAuthnChain()`
`String`	`getDisplayName()`
`String`	`getIconPath()`
`boolean`	`isValid()`	Check if the values in the specified implementation are valid.
`void`	`setAuthnChain(String authnChain)`
`void`	`setDisplayName(String displayName)`
`void`	`setIconPath(String iconPath)`

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

- Field Detail
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - ENABLED_IMPLEMENTATIONS_ATTRIBUTE
```
public static final String ENABLED_IMPLEMENTATIONS_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_ATTRIBUTE
```
public static final String DISPLAY_NAME_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - CHAINS_ATTRIBUTE
```
public static final String CHAINS_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - ICONS_ATTRIBUTE
```
public static final String ICONS_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SocialAuthenticationImplementation
```
public SocialAuthenticationImplementation()
```
- Method Detail
  - getIconPath
```
public String getIconPath()
```
  - setIconPath
```
public void setIconPath(String iconPath)
```
  - getAuthnChain
```
public String getAuthnChain()
```
  - setAuthnChain
```
public void setAuthnChain(String authnChain)
```
  - getDisplayName
```
public String getDisplayName()
```
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - isValid
```
public boolean isValid()
```
    Check if the values in the specified implementation are valid. Currently this just involves checking the values are non null.
    
    Returns:
    
    true if the implementation has all its required values