Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.openxri.pipeline
Interface Stage

All Superinterfaces:
  java.io.Serializable

All Known Implementing Classes:
  AbstractStage, AddAuthorityResolutionSEPStage, AddExpiresAbsoluteStage, AddExpiresRelativeStage, AddGUIDCanonicalIDStage, AddProviderIDStage, AddQueryStage, AddRandomCanonicalIDStage, AddSerialCanonicalIDStage, AddServerStatusStage, AddStatusStage, AddXMLElementStage, AutoLocalIDsStage, EmptyXRDStage, ExecutePipelineStage, FromStoreStage, InheritAttributesStage

    public interface Stage

extends java.io.Serializable

Stages are part of a pipeline and perform some specific task on an XRD. The returned XRD of one stage becomes the input XRD of the next.

Author:
  =peacekeeper

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.
`java.util.Properties` | `getProperties()` Returns the Properties object that was used to initialize the stage.
`void` | `init()` A stage is constructed by the PipelineRegistry by passing a Properties object to its constructor and then calling this init() method.

Method Detail

### init

    void init()
              throws java.lang.Exception

  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`

### getProperties

    java.util.Properties getProperties()

  Returns the Properties object that was used to initialize the stage.

  Returns:
    The stage's properties.

### execute

    XRD execute(Store store,
                XRD xrd,
                XRISegment segment,
                Authority parentAuthority,
                java.lang.String subSegmentName,
                Authority authority,
                boolean isCreate)
                throws StageException

  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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005-2009. All Rights Reserved.