Package com.bea.wli.config

Class Ref

java.lang.Object
com.bea.wli.config.Ref
All Implemented Interfaces:
Serializable, Comparable
public final class Ref extends Object implements Serializable, Comparable
A Ref uniquely represents a resource, project or folder that is managed by the Configuration Framework. A Ref object has two components: A typeId that indicates whether it is a project, folder, or a resource, and an array of names of non-zero length. For a resource the array of names start with the project name, followed by folder names, and end with the resource name. For a project, the Ref object simply contains one name component, that is, the project name. A Ref object for a folder contains the project name followed by the names of the folders which it is nested under.

A special Ref DOMAIN refers to the whole domain.

Note: this class has a natural ordering that is inconsistent with equals.

See Also:

  • Field Details

    • serialVersionUID

      public static final long serialVersionUID
      See Also:

    • MAX_FOLDER_OR_PROJECT_PART_LENGTH

      public static final int MAX_FOLDER_OR_PROJECT_PART_LENGTH
      See Also:

    • DOMAIN_REF

      public static final String DOMAIN_REF
      See Also:

    • PROJECT_REF

      public static final String PROJECT_REF
      See Also:

    • FOLDER_REF

      public static final String FOLDER_REF
      See Also:

    • LOCATION_DATA_TYPE

      public static final String LOCATION_DATA_TYPE
      Type Id for location metadata
      See Also:

    • DOMAIN

      public static final Ref DOMAIN
      Reference to the domain

    • DEFAULT_PROJECT_REF

      public static final Ref DEFAULT_PROJECT_REF
      Default project reference

    • STATIC_PROJECT_REF

      public static final Ref STATIC_PROJECT_REF
      Internal project that always exists

    • PROJECT_DATA_LOCAL_NAME

      public static final String PROJECT_DATA_LOCAL_NAME
      Local name for project data
      See Also:

    • FOLDER_DATA_LOCAL_NAME

      public static final String FOLDER_DATA_LOCAL_NAME
      Local name for folderdata
      See Also:

    • SEPARATOR_CHAR

      public static final char SEPARATOR_CHAR
      Character that separates hierarchical names
      See Also:

    • SEPARATOR_CHAR_PATTERN

      public static final String SEPARATOR_CHAR_PATTERN
      Regular expression representation of the separateor char for pattern matching purposes. This string is the same as SEPARATOR_CHAR except that if the sep char is a special char it contains escape prefix "\"
      See Also:

  • Constructor Details

    • Ref

      public Ref(String typeId, Ref parent, String name)
      Constructor for creating a reference to an object under a particular parent
      Parameters:
      typeId - The type of the reference that will be created
      parent - the parent. If the typeId is project the parent must be the domain reference. If the typeId is folder the parent must be a project or another folder. If the typeId indicates a resource the parent must be a project or a folder.
      name - non-qualified name of the object that will be created. The full name of the created object will be computed by appending this name to the full name of the parent.

    • Ref

      public Ref(String typeId, String[] names)
      Constructor for creating an arbitrary reference.
      Parameters:
      typeId - The type of the reference that will be created
      names - list of name segments composing the fullname, starting with the project name.

  • Method Details

    • getTypeId

      public String getTypeId()
      Returns the type of the reference

    • isDomainRef

      public boolean isDomainRef()
      Returns true if this is the domain reference

    • isProjectRef

      public boolean isProjectRef()
      Returns true if this is a project reference

    • isFolderRef

      public boolean isFolderRef()
      Returns true if this is a folder reference

    • isResourceRef

      public boolean isResourceRef()
      REturns true if this is a resource reference

    • isLocationDataRef

      public boolean isLocationDataRef()
      Returns true if this is a reference to the locationData resource

    • getNames

      public String[] getNames()
      Returns the hierarchical name for the object referenced.

    • getFullName

      public String getFullName()
      Returns the full name of the object. This is a dot separated sequence of reference type followed by names .

    • getLocalName

      public String getLocalName()
      Returns the local name (last name) for the given ref

    • getProjectName

      public String getProjectName() throws IllegalStateException
      Returns the project name If this is a resource reference, project reference of a folder reference. Otherwise throws IllegalStateException
      Throws:
      IllegalStateException - if this is not a project, folder or resource reference

    • getProject

      public Ref getProject() throws IllegalStateException
      Returns the project If this is a resource reference, project reference of a folder reference. Otherwise throws IllegalStateException
      Throws:
      IllegalStateException - if this is not a project, folder or resource reference

    • getParentRef

      public Ref getParentRef()
      Returns a reference to the parent. Returns null if this is domain ref. Returns domain ref, if this is a project reference. Returns the parent (project or folder) reference if this is a folder or a resource.

    • isDescendantOf

      public boolean isDescendantOf(Ref ancestor)
      Returns true if this reference is a descendent (child, grandchild etc...) of the given reference

    • getGlobalName

      public String getGlobalName()

    • parseGlobalNameOld

      public static Ref parseGlobalNameOld(String globalName)

    • parseGlobalName

      public static Ref parseGlobalName(String globalName)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(Object o)
      Specified by:
      compareTo in interface Comparable

    • readResolve

      public Object readResolve()

    • map

      public Ref map(Ref sourceLocation, Ref targetLocation) throws IllegalArgumentException
      Maps a reference to another reference so that a portion of its prefix location is mapped to a target location. For example, if the reference is A/B/C/D/myResource, sourceLocation = A/B, and target location = X/Y/Z then the mapping result would be X/Y/Z/C/D/myResource. If this reference is equal to the source location, the method simply returns the targetLocation.
      Parameters:
      sourceLocation - the prefix location to be changed.
      targetLocation - the new value for the prefix location.
      Returns:
      Throws:
      IllegalArgumentException - if this reference is not under the source location.

    • makeLocationRef

      public static Ref makeLocationRef(String location)
      Deprecated.
      since 2.6
       Factory method to create parent ref for the given location.
 For Eg: if location is project1/folder1/folder2 it creates Ref object for folder2.
      Parameters:
      location -
      Returns:

    • makeLocationDataRef

      public static Ref makeLocationDataRef(Ref location)
      Creates a reference to the metadata that is kept for the given location (folder or project).
      Parameters:
      location - the folder/project for which the location data reference will be computed
      Returns:
      reference to the resource that contains metadata about the given location

    • makeProjectRef

      public static Ref makeProjectRef(String projectName)
      Constructs a reference to project
      Parameters:
      projectName - name of the project
      Returns:
      a reference to the project whose name is given.

    • makeFolderRef

      public static Ref makeFolderRef(Ref parent, String folderName)
      Constructs a reference to a folder
      Parameters:
      parent - the parent. This can be a folder or a project.
      folderName - name of the folder
      Returns:
      a reference to a folder

    • makeRef

      public static Ref makeRef(String typeId, Ref parent, String localname)
      Constructs a reference to an arbitrary object other than the domain and that is hierarchical.
      Parameters:
      typeId - Type of the reference to construct
      parent - the parent. This can be a folder or a project.
      localname - local name for the reference

    • makeRef

      public static Ref makeRef(String typeId, String[] names)
      Constructs a reference to an arbitrary object other than the domain.
      Parameters:
      typeId - Type of the reference to construct
      names - array of names that describe the path to the object being referenced.

    • makeSimpleTypeRef

      public static Ref makeSimpleTypeRef(String typeId, String name)

    • makeResourceRef

      public static Ref makeResourceRef(String resourceType, Ref projectOrFolderRef, String resourceName)
      Convenience constructor for creating an arbitrary resource reference
      Parameters:
      resourceType - type of the resource
      projectOrFolderRef - parent folder or project
      resourceName - name of the resource
      Returns:

    • getDomainRef

      public static Ref getDomainRef()
      Returns the (only) reference to the config fwk domain

    • getNames

      public static String[] getNames(String fullName)
      converts a fullname into its components by splitting it at the separator character SEPARATOR_CHAR
      Parameters:
      fullName - the full (hierarchical) name to the instance

    • validateProjectOrFolderPart

      public static boolean validateProjectOrFolderPart(StringBuilder resultMsg, String name, Locale locale)
      Utility method for validating a folder or project name. If the name argument is valid a true value is returned and resultMsg is not affected. If the name argument is not valid, an error msg is appended to the resultMsg argument, and a false value is returned.
      Parameters:
      resultMsg - Error message is appended to this builder if the name is invalid.
      name - the local name of the project or folder (relative to the project), e.g., myProject, or folderA
      Returns:

    • validateResourceLocalNamePart

      public static boolean validateResourceLocalNamePart(StringBuilder resultMsg, String name, Locale locale)
      Utility method for validating the local name of a resource. If the name argument is valid a true value is returned and resultMsg is not affected. If the name argument is not valid, an error msg is appended to the resultMsg argument, and a false value is returned.
      Parameters:
      resultMsg - Error message is appended to this builder if the name is invalid.
      name - the local name of the resource (relative to its location), e.g., myResource, myWSDL
      Returns:

    • _assertValidProjectOrFolderPart

      public static void _assertValidProjectOrFolderPart(String name) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • _assertValidLocalNamePart

      public static void _assertValidLocalNamePart(String name) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • getLocalNamePart

      public static String getLocalNamePart(String fullName)
      Returns the local name part of the full name. Local name is the last component in a full path.

    • getParentNamePart

      public static String getParentNamePart(String fullName)
      Returns the parent name part of the full name. The parent name is the project or containing folder in the full path.

    • sort

      public static void sort(List<Ref> refList)
       This method returns sorted Ref list
      Parameters:
      refList - List

    • narrowRefs

      public static Set<Ref> narrowRefs(Set<Ref> initialSet, Set<Ref> filter)
      Narrows the initial set so that only those that are specified in the filter remain. This operation is different than the behavior implemented by the Set.retainAll(java.util.Collection<?>), and is not equal to initialSet.retainAll(filter). A reference in the initial set is retained if it exists in the filter set, or if any of its parent locations (folders, and project that it belongs to) exists in the filter.

    • removeMoreSpecific

      public static void removeMoreSpecific(Set<Ref> set)
      Remove a ref R1 from set if there exists another ref R2 in the set such that R1 is under R2.

    • relativize

      public static String relativize(Ref source, Ref dest)
      creates a relative path for the given destination resource ref against the given base resource ref.