org.openxri.pipeline.stages
Class AddServerStatusStage

java.lang.Object
  extended by org.openxri.pipeline.stages.AbstractStage
      extended by org.openxri.pipeline.stages.AddServerStatusStage
All Implemented Interfaces:
java.io.Serializable, Stage

public class AddServerStatusStage
extends AbstractStage

A stage that adds an tag to the XRD with a configurable code and text. Parameters for the stage's configuration: code (optional, default: "100"): The status code to add to the element text (optional, default: "Success"): The status text to add to the element Recommended pipeline(s) for this stage: LOOKUP

Author:
=peacekeeper
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_CODE
           
static java.lang.String DEFAULT_TEXT
           
static java.lang.String PROPERTIES_KEY_CODE
           
static java.lang.String PROPERTIES_KEY_TEXT
           
 
Fields inherited from class org.openxri.pipeline.stages.AbstractStage
properties
 
Constructor Summary
AddServerStatusStage(java.util.Properties properties)
           
 
Method Summary
 XRD execute(Store store, XRD xrd, XRISegment segment, Authority parentAuthority, java.lang.String subSegmentName, Authority authority, boolean isCreate)
          Called as part of executing a pipeline.
 void init()
          A stage is constructed by the PipelineRegistry by passing a Properties object to its constructor and then calling this init() method.
 
Methods inherited from class org.openxri.pipeline.stages.AbstractStage
getProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTIES_KEY_CODE

public static final java.lang.String PROPERTIES_KEY_CODE
See Also:
Constant Field Values

PROPERTIES_KEY_TEXT

public static final java.lang.String PROPERTIES_KEY_TEXT
See Also:
Constant Field Values

DEFAULT_CODE

public static final java.lang.String DEFAULT_CODE
See Also:
Constant Field Values

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT
See Also:
Constant Field Values
Constructor Detail

AddServerStatusStage

public AddServerStatusStage(java.util.Properties properties)
Method Detail

init

public void init()
          throws java.lang.Exception
Description copied from interface: Stage
A stage is constructed by the PipelineRegistry by passing a Properties object to its constructor and then calling this init() method.

Throws:
java.lang.Exception

execute

public XRD execute(Store store,
                   XRD xrd,
                   XRISegment segment,
                   Authority parentAuthority,
                   java.lang.String subSegmentName,
                   Authority authority,
                   boolean isCreate)
            throws StageException
Description copied from interface: Stage
Called as part of executing a pipeline.

Parameters:
store - The store from which the authorities were retrieved.
xrd - A XRD as it currently looks like on the pipeline. The stage is free to modify and return it in any way.
segment - The XRI segment that resolves to the XRD being processed.
parentAuthority - The parent authority, i.e. the authority describing the XRD.
subSegmentName - The name of the subsegment that connects the two authorities.
authority - The authority, i.e. the authority described by the XRD.
isCreate - Whether this stage is execute as part of a CREATE pipeline.
Returns:
The XRD that is passed on to the next stage of the pipeline.
Throws:
StageException


Copyright © 2005-2012. All Rights Reserved.