SAML2SessionPartner (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.saml2.profile.SAML2SessionPartner

public class SAML2SessionPartner
extends Object

This class encapsulates session partner.

Constructor Summary

Constructors
Constructor Description

SAML2SessionPartner(String sessionPartner, boolean isRoleIDP)
Constructs a new SAML2SessionPartner object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getPartner()`	Returns session partner's provider ID.
`boolean`	`isEquals(String partnerID)`	Checks if the session partner's provider ID equals to the one with this object.
`boolean`	`isIDPRole()`	Returns the role of the session partner.
`void`	`setIDPRole(boolean roleIDP)`	Sets the role of the session partner.
`void`	`setPartner(String sessionPartner)`	Sets session partner's provider ID.

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

- Constructor Detail
  - SAML2SessionPartner
```
public SAML2SessionPartner(String sessionPartner,
                           boolean isRoleIDP)
```
    Constructs a new SAML2SessionPartner object.
    
    Parameters:
    
    sessionPartner - session partner's provider ID
    
    isRoleIDP - if the session partner's role is IDP
- Method Detail
  - getPartner
```
public String getPartner()
```
    Returns session partner's provider ID.
    
    Returns:
    
    session partner's provider ID
  - setPartner
```
public void setPartner(String sessionPartner)
```
    Sets session partner's provider ID.
    
    Parameters:
    
    sessionPartner - session partner's provider ID
  - isIDPRole
```
public boolean isIDPRole()
```
    Returns the role of the session partner.
    
    Returns:
    
    true if the role of the session partner is IDP; false otherwise.
  - setIDPRole
```
public void setIDPRole(boolean roleIDP)
```
    Sets the role of the session partner.
    
    Parameters:
    
    roleIDP - true if the role of the session partner is IDP; false otherwise.
  - isEquals
```
public boolean isEquals(String partnerID)
```
    Checks if the session partner's provider ID equals to the one with this object.
    
    Parameters:
    
    partnerID - session partner's provider ID to compare to
    
    Returns:
    
    true if the two session partner's provider IDs are the same; false otherwise.