Package com.aspectran.core.context.rule

Class ResponseRule

java.lang.Object

com.aspectran.core.context.rule.ResponseRule

All Implemented Interfaces:

ActionRuleApplicable, Replicable<ResponseRule>, ResponseRuleApplicable

public class ResponseRule
extends Object
implements ActionRuleApplicable, ResponseRuleApplicable, Replicable<ResponseRule>

The Class ResponseRule.

Created: 2008. 03. 22 PM 5:48:09

Constructor Summary

Constructors

Constructor	Description
ResponseRule(boolean explicit)	Instantiates a new ResponseRule.

Method Summary

Modifier and Type	Method	Description
void	applyActionRule(Executable action)	Adds an executable action instance.
Executable	applyActionRule(AnnotatedActionRule annotatedActionRule)	Adds the annotated method action rule.
Executable	applyActionRule(ChooseRule chooseRule)	Adds a list of action instances that can be executed.
Executable	applyActionRule(EchoActionRule echoActionRule)	Adds the echo action rule.
Executable	applyActionRule(HeaderActionRule headerActionRule)	Adds the header action rule.
Executable	applyActionRule(IncludeActionRule includeActionRule)	Adds the include action rule.
Executable	applyActionRule(InvokeActionRule invokeActionRule)	Adds the invoke action rule.
Response	applyResponseRule(DispatchRule dispatchRule)	Apply the dispatch rule to the response rule.
Response	applyResponseRule(ForwardRule forwardRule)	Apply the forward rule to the response rule.
Response	applyResponseRule(RedirectRule redirectRule)	Apply the redirect rule to the response rule.
Response	applyResponseRule(TransformRule transformRule)	Apply the transform rule to the response rule.
ActionList	getActionList()
String	getEncoding()	Gets the response encoding.
String	getName()
Response	getResponse()
ResponseType	getResponseType()
boolean	isExplicit()
static ResponseRule	newInstance(CustomTransformResponse response)
static ResponseRule	newInstance(DispatchRule dispatchRule)
static ResponseRule	newInstance(ForwardRule forwardRule)
static ResponseRule	newInstance(RedirectRule redirectRule)
static ResponseRule	newInstance(TransformRule transformRule)
static ResponseRule	newInstance(String name, String encoding)
ResponseRule	replicate()	Creates and returns a new instance after replicating a rule or Object.
static ResponseRule	replicate(ResponseRule responseRule)
void	setActionList(ActionList actionList)
void	setEncoding(String encoding)	Sets the response encoding.
void	setName(String name)
void	setResponse(Response response)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ResponseRule

public ResponseRule(boolean explicit)

Instantiates a new ResponseRule.

Parameters:

explicit - whether this response rule is explicit

Method Details

isExplicit

public boolean isExplicit()

getName

public String getName()

setName

public void setName(String name)

getEncoding

public String getEncoding()

Gets the response encoding.

Returns:

the response encoding

setEncoding

public void setEncoding(String encoding)

Sets the response encoding.

Parameters:

encoding - the new response encoding

getActionList

public ActionList getActionList()

setActionList

public void setActionList(ActionList actionList)

applyActionRule

public Executable applyActionRule(HeaderActionRule headerActionRule)

Description copied from interface: ActionRuleApplicable

Adds the header action rule.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

headerActionRule - the header action rule

Returns:

an instance of the executable action

applyActionRule

public Executable applyActionRule(EchoActionRule echoActionRule)

Description copied from interface: ActionRuleApplicable

Adds the echo action rule.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

echoActionRule - the echo action rule

Returns:

an instance of the executable action

applyActionRule

public Executable applyActionRule(InvokeActionRule invokeActionRule)

Description copied from interface: ActionRuleApplicable

Adds the invoke action rule.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

invokeActionRule - the invoke action rule

Returns:

an instance of the executable action

applyActionRule

public Executable applyActionRule(AnnotatedActionRule annotatedActionRule)

Description copied from interface: ActionRuleApplicable

Adds the annotated method action rule.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

annotatedActionRule - the annotated method action rule

Returns:

an instance of the executable action

applyActionRule

public Executable applyActionRule(IncludeActionRule includeActionRule)

Description copied from interface: ActionRuleApplicable

Adds the include action rule.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

includeActionRule - the include action rule

Returns:

an instance of the executable action

applyActionRule

public Executable applyActionRule(ChooseRule chooseRule)

Description copied from interface: ActionRuleApplicable

Adds a list of action instances that can be executed.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

chooseRule - the choose rule

Returns:

an instance of the executable action

applyActionRule

public void applyActionRule(Executable action)

Description copied from interface: ActionRuleApplicable

Adds an executable action instance.

Specified by:

applyActionRule in interface ActionRuleApplicable

Parameters:

action - an executable action instance

getResponse

public Response getResponse()

setResponse

public void setResponse(Response response)

getResponseType

public ResponseType getResponseType()

applyResponseRule

public Response applyResponseRule(TransformRule transformRule)

Description copied from interface: ResponseRuleApplicable

Apply the transform rule to the response rule.

Specified by:

applyResponseRule in interface ResponseRuleApplicable

Parameters:

transformRule - the transform rule

Returns:

the response

applyResponseRule

public Response applyResponseRule(DispatchRule dispatchRule)

Description copied from interface: ResponseRuleApplicable

Apply the dispatch rule to the response rule.

Specified by:

applyResponseRule in interface ResponseRuleApplicable

Parameters:

dispatchRule - the dispatch rule

Returns:

the response

applyResponseRule

public Response applyResponseRule(ForwardRule forwardRule)

Description copied from interface: ResponseRuleApplicable

Apply the forward rule to the response rule.

Specified by:

applyResponseRule in interface ResponseRuleApplicable

Parameters:

forwardRule - the forward rule

Returns:

the response

applyResponseRule

public Response applyResponseRule(RedirectRule redirectRule)

Description copied from interface: ResponseRuleApplicable

Apply the redirect rule to the response rule.

Specified by:

applyResponseRule in interface ResponseRuleApplicable

Parameters:

redirectRule - the redirect rule

Returns:

the response

replicate

public ResponseRule replicate()

Description copied from interface: Replicable

Creates and returns a new instance after replicating a rule or Object.

Specified by:

replicate in interface Replicable<ResponseRule>

Returns:

replicated rule or new instance of Object

toString

public String toString()

Overrides:

toString in class Object

newInstance

@NonNull
public static ResponseRule newInstance(String name,
 String encoding)
                                throws IllegalRuleException

Throws:

IllegalRuleException

newInstance

@NonNull
public static ResponseRule newInstance(TransformRule transformRule)

newInstance

@NonNull
public static ResponseRule newInstance(DispatchRule dispatchRule)

newInstance

@NonNull
public static ResponseRule newInstance(ForwardRule forwardRule)

newInstance

@NonNull
public static ResponseRule newInstance(RedirectRule redirectRule)

newInstance

@NonNull
public static ResponseRule newInstance(CustomTransformResponse response)

replicate

@NonNull
public static ResponseRule replicate(@NonNull
 ResponseRule responseRule)