BuildSAMLMetadataContextAction (Shibboleth IdP :: CAS Protocol Implementation 4.3.1 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.profile.action.AbstractProfileAction
  - - org.opensaml.profile.action.AbstractConditionalProfileAction
    - - net.shibboleth.idp.profile.AbstractProfileAction
      - net.shibboleth.idp.cas.flow.impl.AbstractCASProtocolAction<RequestType,ResponseType>
        
        net.shibboleth.idp.cas.flow.impl.BuildSAMLMetadataContextAction<RequestType,ResponseType>

Type Parameters:

RequestType - request

ResponseType - response

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action
```
public class BuildSAMLMetadataContextAction<RequestType,ResponseType>
extends AbstractCASProtocolAction<RequestType,ResponseType>
```
Builds a SAMLMetadataContext child of RelyingPartyContext to facilitate relying party selection by group name. Possible outcomes:
- null on success
- IllegalState

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`relyingPartyIdFromMetadata`	Whether to overwrite the relying party ID based on metadata.
`private RelyingPartyContext`	`rpCtx`	RelyingPartyContext.
`private Service`	`service`	CAS service.

Constructor Summary

Constructors
Constructor Description

BuildSAMLMetadataContextAction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext)`
`protected boolean`	`doPreExecute(ProfileRequestContext profileRequestContext)`
`void`	`setRelyingPartyIdFromMetadata(boolean flag)`	Sets whether the `RelyingPartyContext.getRelyingPartyId()` method should return an entityID established from SAML metadata instead of the service URL.

Methods inherited from class net.shibboleth.idp.cas.flow.impl.AbstractCASProtocolAction
getCASRequest, getCASResponse, getCASService, getCASTicket, getProtocolContext, setCASRequest, setCASResponse, setCASService, setCASTicket

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction
doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction
getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized

- Field Detail
  - relyingPartyIdFromMetadata
```
private boolean relyingPartyIdFromMetadata
```
    Whether to overwrite the relying party ID based on metadata.
  - service
```
@Nullable
private Service service
```
    CAS service.
  - rpCtx
```
@Nullable
private RelyingPartyContext rpCtx
```
    RelyingPartyContext.
- Constructor Detail
  - BuildSAMLMetadataContextAction
```
public BuildSAMLMetadataContextAction()
```
- Method Detail
  - setRelyingPartyIdFromMetadata
```
public void setRelyingPartyIdFromMetadata(boolean flag)
```
    Sets whether the RelyingPartyContext.getRelyingPartyId() method should return an entityID established from SAML metadata instead of the service URL.
    Defaults to false for compatibility.
    
    Parameters:
    
    flag - flag to set
  - doPreExecute
```
protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)
```
    Overrides:
    
    doPreExecute in class AbstractConditionalProfileAction
  - doExecute
```
protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)
```
    Overrides:
    
    doExecute in class AbstractProfileAction