Package org.glassfish.jersey.server.model

Class RuntimeResource

  • All Implemented Interfaces:
    ResourceModelComponent
    public class RuntimeResource
extends java.lang.Object
implements ResourceModelComponent
    Runtime resource is a group of resources with the same path regular expression. Runtime resource is constructed from resources creating the resource model.

    Runtime resource can have child runtime resources which are groups of child resources of all resources constructing this runtime resource.

    The following example shows how Runtime resource structure is built from Resource model: 

     @Path("{foo}")
 public class TemplateResourceFoo {
     @GET
     @Path("child")
     public String getFoo() {...}

     @Path("{x}")
     @GET
     public String getX() {...}

     @Path("{y}")
     @POST
     public String postY(String entity) {...}
 }

 @Path("{bar}")
 public class TemplateResourceBar {
     @Path("{z}")
     @PUT
     public String putZ(String entity) {...}
 }
    Will be represented by RuntimeResources:
    line RuntimeResource regex Grouped Resources (paths) Parent RuntimeResource (line)
    1 "/([^/]+?)" Resource("{foo}"), Resource("{bar}") no parent
    2 "child" Child Resource("child") 1
    3 "/([^/]+?)" Child Resource("{x}"), Child Resource("{y}"), Child Resource("{z}") 1

    • Field Detail

      • COMPARATOR

        public static final java.util.Comparator<RuntimeResource> COMPARATOR
        Comparator of RuntimeResources based on rules respecting resource matching algorithm.

      • regex

        private final java.lang.String regex

      • resourceMethods

        private final java.util.List<ResourceMethod> resourceMethods

      • resourceLocators

        private final java.util.List<ResourceMethod> resourceLocators

      • childRuntimeResources

        private final java.util.List<RuntimeResource> childRuntimeResources

      • resources

        private final java.util.List<Resource> resources

    • Method Detail

      • getChildRuntimeResources

        public java.util.List<RuntimeResource> getChildRuntimeResources()
        Get child runtime resources of this resource.
        Returns:
        List of child runtime resource.

      • getRegex

        public java.lang.String getRegex()
        Get regular expression of path pattern of this runtime resource.
        Returns:
        Matching regular expression.

      • getResourceMethods

        public java.util.List<ResourceMethod> getResourceMethods()
        Get resource methods (excluding resource locators) of all resources of this runtime resource.
        Returns:
        List of resource methods.

      • getResourceLocators

        public java.util.List<ResourceMethod> getResourceLocators()
        Get resource locators of all resources of this runtime resource.

        Note that valid RuntimeResource should have only one resource locator. This method is used for validation purposes.

        Returns:
        List of resource locators.

      • getResourceLocator

        public ResourceMethod getResourceLocator()
        Return the resource locator of this resource.
        Returns:
        Resource locator of this runtime resource.

      • getParent

        public RuntimeResource getParent()
        Get parent of this runtime resource.
        Returns:
        Parent runtime resource if this runtime resource is a child resource, null otherwise.

      • getPathPattern

        public PathPattern getPathPattern()
        Get path pattern for matching purposes.
        Returns:
        Path pattern.

      • getFullPathRegex

        public java.lang.String getFullPathRegex()
        Get full regular expression of this runtime resource prefixed by regular expression of parent if present.
        Returns:
        Full resource regular expression.

      • getParentResources

        public java.util.List<Resource> getParentResources()
        Return parent resources of resources from this runtime resource. The returned list is ordered so that the position of the parent resource in the returned list is the same as position of its child resource in list returned by getResources(). Simply said the order of lists returned from getParentResources() and getResources() from parent-child point of view is the same. If the resource has no parent then the element null is in the list.
        Returns:
        Parent resource list with resources if this runtime resource is child resource or null elements if this runtime resource is the parent resource.

      • getResources

        public java.util.List<Resource> getResources()
        Get resources creating this runtime resource.
        Returns:
        List of resources with same path regular expression which this resource is based on.