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.stages
Class FromStoreStage

    java.lang.Object
      org.openxri.pipeline.stages.AbstractStage
          org.openxri.pipeline.stages.FromStoreStage

All Implemented Interfaces:
  java.io.Serializable, Stage

    public class FromStoreStage

extends AbstractStage

A stage looks up the XRD for the current subsegment from the store, and replaces the current XRD on the pipeline. This is the recommended first stage on the default LOOOKUP stage. If there is no matching subsegment/authority in the store, the stage returns NULL, which causes the pipeline to return NULL too, ultimately causing the AbstractServer to send a 222 error XRD. Parameters for the stage's configuration: (none) Recommended pipeline(s) for this stage: LOOKUP

Author:
  =peacekeeper
See Also:
  Serialized Form

Field Summary

Fields inherited from class org.openxri.pipeline.stages.AbstractStage
`properties`

Constructor Summary
`FromStoreStage(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`

Constructor Detail

### FromStoreStage

    public FromStoreStage(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`

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.