Package com.ibm.wsspi.artifact

Interface EnclosedEntity

All Superinterfaces:
Entity
All Known Subinterfaces:
ArtifactContainer, ArtifactEntry, OverlayContainer
public interface EnclosedEntity extends Entity
Represents something enclosed by a Container.

  • Method Summary

    Modifier and Type
    Method
    Description
    ArtifactContainer
    getEnclosingContainer()
    Get the Container that encloses this entity.
    String
    getPath()
    Get the path of this Entity within it's parents.
    String
    getPhysicalPath()
    Deprecated.
    added purely to support getRealPath on ServletContext ..
    ArtifactContainer
    getRoot()
    Get the Container within this local root hierarchy, that would report isRoot=true.

    Methods inherited from interface com.ibm.wsspi.artifact.Entity

    getName

  • Method Details

    • getEnclosingContainer

      ArtifactContainer getEnclosingContainer()
      Get the Container that encloses this entity.
      Returns:
      container enclosing this entity, or null if there is none.

    • getPath

      String getPath()
      Get the path of this Entity within it's parents. The returned path is guaranteed to not include a trailing path separator character.
      Returns:
      path of container.

    • getRoot

      ArtifactContainer getRoot()
      Get the Container within this local root hierarchy, that would report isRoot=true.

      Calling this on a Container that returns isRoot=true, will return that same Container
      Calling this say, on an entry in a jar, will return the container representing the jar.
      Calling this on the container representing the jar, will return itself.

    • getPhysicalPath

      @Deprecated String getPhysicalPath()
      Deprecated.
      added purely to support getRealPath on ServletContext .. post alpha this will need replacing.

      Get path for this Entity. Not all implementations of this interface need to support this method and should return null if they do not support them.

      If the entry is container within an archive file such as a JAR or ZIP then this will return null.

      For directories that have more than one physical location mapped to them then this will return the first mapped resource.

      Returns:
      String representing physical path on disk for this entity.. null if there is none. null is very possible.