LogSpringContextInfo (Shibboleth Identity Provider 4.3.4-SNAPSHOT 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.profile.impl.LogSpringContextInfo

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, ApplicationContextAware, MessageSource, MessageSourceAware, Action
```
public class LogSpringContextInfo
extends AbstractProfileAction
implements ApplicationContextAware
```
Spring Web Flow utility action for logging on DEBUG details about the current hierarchy of Spring ApplicationContext and the beans contained within each.
You can contextualize the logging of the info either by setting setDescription(String), or more usefully by using an attribute on the specific action expression as below. This allows using just one declaration of the action bean, but parameterized differently depending on where it is placed.
```
 
 <evaluate expression="LogSpringContextInfo">
    <attribute name="springInfoDescription" value="My Description" />
 </evaluate>
  
 
```

Field Summary

Fields
Modifier and Type	Field	Description
`private ApplicationContext`	`applicationContext`	The owning Spring ApplicationContext in which this action is defined.
`static String`	`ATTRIB_DESC`	Name of Spring web flow attribute holding the description of the tree to log.
`private String`	`description`	Contextual description to output at the start of the action.
`private org.slf4j.Logger`	`log`	Logger.

Constructor Summary

Constructors
Constructor Description

LogSpringContextInfo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext)`
`void`	`setApplicationContext(ApplicationContext context)`
`void`	`setDescription(String value)`	Set the contextual description to output at the start of the action.

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
doPreExecute, 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
  - ATTRIB_DESC
```
public static final String ATTRIB_DESC
```
    Name of Spring web flow attribute holding the description of the tree to log.
    
    See Also:
    
    Constant Field Values
  - log
```
private org.slf4j.Logger log
```
    Logger.
  - applicationContext
```
private ApplicationContext applicationContext
```
    The owning Spring ApplicationContext in which this action is defined.
  - description
```
private String description
```
    Contextual description to output at the start of the action.
- Constructor Detail
  - LogSpringContextInfo
```
public LogSpringContextInfo()
```
- Method Detail
  - setDescription
```
public void setDescription(@Nullable
                           String value)
```
    Set the contextual description to output at the start of the action.
    
    Parameters:
    
    value - the description value
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext context)
                           throws BeansException
```
    Specified by:
    
    setApplicationContext in interface ApplicationContextAware
    
    Throws:
    
    BeansException
  - doExecute
```
protected void doExecute(ProfileRequestContext profileRequestContext)
```
    Overrides:
    
    doExecute in class AbstractProfileAction