Package org.apereo.cas.web.flow

Interface CasWebflowConfigurer

  • All Superinterfaces:
    org.springframework.core.Ordered
    public interface CasWebflowConfigurer
extends org.springframework.core.Ordered
    This is CasWebflowConfigurer.
    Since:
    5.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FLOW_ID_LOGIN
      Main login flow id.
      static java.lang.String FLOW_ID_LOGOUT
      Main logout flow id.

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.springframework.webflow.engine.Flow buildFlow​(java.lang.String location, java.lang.String id)
      Build flow.
      org.springframework.webflow.engine.ActionState createActionState​(org.springframework.webflow.engine.Flow flow, java.lang.String name, org.springframework.webflow.execution.Action... actions)
      Create action state action state.
      org.springframework.webflow.engine.DecisionState createDecisionState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String testExpression, java.lang.String thenStateId, java.lang.String elseStateId)
      Create decision state decision state.
      org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow, java.lang.String id)
      Create end state.
      org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId)
      Create end state.
      org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId, boolean redirect)
      Create end state with option to handle an external redirect.
      org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.binding.expression.Expression expression)
      Create end state.
      org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.webflow.execution.ViewFactory viewFactory)
      Create end state.
      org.springframework.webflow.action.EvaluateAction createEvaluateAction​(java.lang.String expression)
      Create evaluate action evaluate action.
      org.springframework.webflow.action.SetAction createSetAction​(java.lang.String name, java.lang.String value)
      Create set action set action.
      org.springframework.webflow.engine.SubflowState createSubflowState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String subflow)
      Create subflow state subflow state.
      org.springframework.webflow.engine.SubflowState createSubflowState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String subflow, org.springframework.webflow.execution.Action entryAction)
      Create subflow state subflow state.
      org.springframework.webflow.engine.Transition createTransition​(java.lang.String targetState)
      Create transition transition.
      org.springframework.webflow.engine.Transition createTransition​(java.lang.String criteriaOutcome, java.lang.String targetState)
      Create transition transition.
      org.springframework.webflow.engine.Transition createTransition​(java.lang.String criteriaOutcome, org.springframework.webflow.engine.TransitionableState targetState)
      Create transition transition.
      org.springframework.webflow.engine.Transition createTransition​(org.springframework.binding.expression.Expression criteriaOutcomeExpression, java.lang.String targetState)
      Create transition transition.
      org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId)
      Create view state view state.
      org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId, org.springframework.webflow.engine.builder.BinderConfiguration binder)
      Create view state view state.
      org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.binding.expression.Expression expression, org.springframework.webflow.engine.builder.BinderConfiguration binder)
      Create view state view state.
      org.springframework.webflow.engine.Flow getLoginFlow()
      Gets login flow.
      org.springframework.webflow.engine.Flow getLogoutFlow()
      Gets logout flow.
      default java.lang.String getName()
      Gets name.
      org.springframework.webflow.engine.TransitionableState getStartState​(org.springframework.webflow.engine.Flow flow)
      Gets start state.
      void initialize()
      Initialize.
      void setStartState​(org.springframework.webflow.engine.Flow flow, java.lang.String state)
      Sets start state.
      void setStartState​(org.springframework.webflow.engine.Flow flow, org.springframework.webflow.engine.TransitionableState state)
      Sets start state.

      • Methods inherited from interface org.springframework.core.Ordered

        getOrder

    • Field Detail

      • FLOW_ID_LOGIN

        static final java.lang.String FLOW_ID_LOGIN
        Main login flow id.
        See Also:
        Constant Field Values

      • FLOW_ID_LOGOUT

        static final java.lang.String FLOW_ID_LOGOUT
        Main logout flow id.
        See Also:
        Constant Field Values

    • Method Detail

      • initialize

        void initialize()
        Initialize.

      • getLoginFlow

        org.springframework.webflow.engine.Flow getLoginFlow()
        Gets login flow.
        Returns:
        the login flow

      • getLogoutFlow

        org.springframework.webflow.engine.Flow getLogoutFlow()
        Gets logout flow.
        Returns:
        the logout flow

      • getStartState

        org.springframework.webflow.engine.TransitionableState getStartState​(org.springframework.webflow.engine.Flow flow)
        Gets start state.
        Parameters:
        flow - the flow
        Returns:
        the start state

      • createTransition

        org.springframework.webflow.engine.Transition createTransition​(java.lang.String criteriaOutcome,
                                                               java.lang.String targetState)
        Create transition transition.
        Parameters:
        criteriaOutcome - the criteria outcome
        targetState - the target state
        Returns:
        the transition

      • createTransition

        org.springframework.webflow.engine.Transition createTransition​(java.lang.String criteriaOutcome,
                                                               org.springframework.webflow.engine.TransitionableState targetState)
        Create transition transition.
        Parameters:
        criteriaOutcome - the criteria outcome
        targetState - the target state
        Returns:
        the transition

      • createTransition

        org.springframework.webflow.engine.Transition createTransition​(org.springframework.binding.expression.Expression criteriaOutcomeExpression,
                                                               java.lang.String targetState)
        Create transition transition.
        Parameters:
        criteriaOutcomeExpression - the criteria outcome expression
        targetState - the target state
        Returns:
        the transition

      • createTransition

        org.springframework.webflow.engine.Transition createTransition​(java.lang.String targetState)
        Create transition transition.
        Parameters:
        targetState - the target state
        Returns:
        the transition

      • createSetAction

        org.springframework.webflow.action.SetAction createSetAction​(java.lang.String name,
                                                             java.lang.String value)
        Create set action set action.
        Parameters:
        name - the name
        value - the value
        Returns:
        the set action

      • createEvaluateAction

        org.springframework.webflow.action.EvaluateAction createEvaluateAction​(java.lang.String expression)
        Create evaluate action evaluate action.
        Parameters:
        expression - the expression
        Returns:
        the evaluate action

      • createActionState

        org.springframework.webflow.engine.ActionState createActionState​(org.springframework.webflow.engine.Flow flow,
                                                                 java.lang.String name,
                                                                 org.springframework.webflow.execution.Action... actions)
        Create action state action state.
        Parameters:
        flow - the flow
        name - the name
        actions - the actions
        Returns:
        the action state

      • createDecisionState

        org.springframework.webflow.engine.DecisionState createDecisionState​(org.springframework.webflow.engine.Flow flow,
                                                                     java.lang.String id,
                                                                     java.lang.String testExpression,
                                                                     java.lang.String thenStateId,
                                                                     java.lang.String elseStateId)
        Create decision state decision state.
        Parameters:
        flow - the flow
        id - the id
        testExpression - the test expression
        thenStateId - the then state id
        elseStateId - the else state id
        Returns:
        the decision state

      • setStartState

        void setStartState​(org.springframework.webflow.engine.Flow flow,
                   java.lang.String state)
        Sets start state.
        Parameters:
        flow - the flow
        state - the state

      • setStartState

        void setStartState​(org.springframework.webflow.engine.Flow flow,
                   org.springframework.webflow.engine.TransitionableState state)
        Sets start state.
        Parameters:
        flow - the flow
        state - the state

      • createEndState

        org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow,
                                                           java.lang.String id)
        Create end state.
        Parameters:
        flow - the flow
        id - the id
        Returns:
        the end state

      • createEndState

        org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow,
                                                           java.lang.String id,
                                                           java.lang.String viewId,
                                                           boolean redirect)
        Create end state with option to handle an external redirect.
        Parameters:
        flow - the flow
        id - the id
        viewId - the view id
        redirect - the redirect
        Returns:
        the end state

      • createEndState

        org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow,
                                                           java.lang.String id,
                                                           java.lang.String viewId)
        Create end state.
        Parameters:
        flow - the flow
        id - the id
        viewId - the view id
        Returns:
        the end state

      • createEndState

        org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow,
                                                           java.lang.String id,
                                                           org.springframework.binding.expression.Expression expression)
        Create end state.
        Parameters:
        flow - the flow
        id - the id
        expression - the expression
        Returns:
        the end state

      • createEndState

        org.springframework.webflow.engine.EndState createEndState​(org.springframework.webflow.engine.Flow flow,
                                                           java.lang.String id,
                                                           org.springframework.webflow.execution.ViewFactory viewFactory)
        Create end state.
        Parameters:
        flow - the flow
        id - the id
        viewFactory - the view factory
        Returns:
        the end state

      • createViewState

        org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow,
                                                             java.lang.String id,
                                                             org.springframework.binding.expression.Expression expression,
                                                             org.springframework.webflow.engine.builder.BinderConfiguration binder)
        Create view state view state.
        Parameters:
        flow - the flow
        id - the id
        expression - the expression
        binder - the binder
        Returns:
        the view state

      • createViewState

        org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow,
                                                             java.lang.String id,
                                                             java.lang.String viewId)
        Create view state view state.
        Parameters:
        flow - the flow
        id - the id
        viewId - the view id
        Returns:
        the view state

      • createViewState

        org.springframework.webflow.engine.ViewState createViewState​(org.springframework.webflow.engine.Flow flow,
                                                             java.lang.String id,
                                                             java.lang.String viewId,
                                                             org.springframework.webflow.engine.builder.BinderConfiguration binder)
        Create view state view state.
        Parameters:
        flow - the flow
        id - the id
        viewId - the view id
        binder - the binder
        Returns:
        the view state

      • createSubflowState

        org.springframework.webflow.engine.SubflowState createSubflowState​(org.springframework.webflow.engine.Flow flow,
                                                                   java.lang.String id,
                                                                   java.lang.String subflow,
                                                                   org.springframework.webflow.execution.Action entryAction)
        Create subflow state subflow state.
        Parameters:
        flow - the flow
        id - the id
        subflow - the subflow
        entryAction - the entry action
        Returns:
        the subflow state

      • createSubflowState

        org.springframework.webflow.engine.SubflowState createSubflowState​(org.springframework.webflow.engine.Flow flow,
                                                                   java.lang.String id,
                                                                   java.lang.String subflow)
        Create subflow state subflow state.
        Parameters:
        flow - the flow
        id - the id
        subflow - the subflow
        Returns:
        the subflow state

      • buildFlow

        org.springframework.webflow.engine.Flow buildFlow​(java.lang.String location,
                                                  java.lang.String id)
        Build flow.
        Parameters:
        location - the location
        id - the id
        Returns:
        the flow

      • getName

        default java.lang.String getName()
        Gets name.
        Returns:
        the name