Class ResourceMethod

    • Constructor Detail

      • ResourceMethod

        ResourceMethod​(Resource parent,
                       ResourceMethod.Data data)
        Create new resource method model instance.
        Parameters:
        parent - parent resource model.
        data - resource method model data.
    • Method Detail

      • transform

        static java.util.List<ResourceMethod> transform​(Resource parent,
                                                        java.util.List<ResourceMethod.Data> list)
        Transform a collection of resource method data into resource method models.
        Parameters:
        parent - parent resource model.
        list - resource method data collection.
        Returns:
        transformed resource method models.
      • getData

        ResourceMethod.Data getData()
        Get model data represented by this resource method.
        Returns:
        model data represented by this resource method.
      • getParent

        public Resource getParent()
        Get the parent resource for this resource method model.

        May return null in case the resource method is not bound to an existing resource. This is typical for resource method models returned directly from the ResourceMethod.Builder.build() method.

        Returns:
        parent resource, or null if there is no parent resource associated with the method.
        Since:
        2.1
      • getHttpMethod

        public java.lang.String getHttpMethod()
        Get the associated HTTP method.

        May return null in case the method represents a sub-resource locator.

        Returns:
        the associated HTTP method, or null in case this method represents a sub-resource locator.
      • getInvocable

        public Invocable getInvocable()
        Get the invocable method model.
        Returns:
        invocable method model.
      • isExtended

        public boolean isExtended()
        Get the flag indicating whether the resource method is extended or is a core of exposed RESTful API.

        Extended resource model components are helper components that are not considered as a core of a RESTful API. These can be for example OPTIONS resource methods added by model processors or application.wadl resource producing the WADL. Both resource are rather supportive than the core of RESTful API.

        If not set the resource will not be defined as extended by default.

        Returns:
        true if the method is extended.
        Since:
        2.5.1
        See Also:
        ExtendedResource
      • getConsumedTypes

        public java.util.List<javax.ws.rs.core.MediaType> getConsumedTypes()
        Description copied from interface: Consuming
        Get the consumed media types supported by the component.
        Specified by:
        getConsumedTypes in interface Consuming
        Returns:
        immutable collection of supported consumed media types.
      • getProducedTypes

        public java.util.List<javax.ws.rs.core.MediaType> getProducedTypes()
        Description copied from interface: Producing
        Get the produced media types supported by the component.
        Specified by:
        getProducedTypes in interface Producing
        Returns:
        immutable collection of supported produced media types.
      • getSuspendTimeout

        public long getSuspendTimeout()
        Description copied from interface: Suspendable
        Get the suspend timeout value in the given time unit.
        Specified by:
        getSuspendTimeout in interface Suspendable
        Returns:
        suspend timeout value.
      • getSuspendTimeoutUnit

        public java.util.concurrent.TimeUnit getSuspendTimeoutUnit()
        Description copied from interface: Suspendable
        Get the suspend timeout value time unit.
        Specified by:
        getSuspendTimeoutUnit in interface Suspendable
        Returns:
        time unit of the suspend timeout value.
      • isSuspendDeclared

        public boolean isSuspendDeclared()
        Description copied from interface: Suspendable
        Check if the component is marked for suspending.
        Specified by:
        isSuspendDeclared in interface Suspendable
        Returns:
        true if the component is marked for suspending, false otherwise.
      • isSse

        public boolean isSse()
        Check whether the resource method will be producing Server-sent event stream.
        Returns:
        true if the resource method produces Server-sent event stream, false otherwise.
      • isManagedAsyncDeclared

        public boolean isManagedAsyncDeclared()
        Description copied from interface: Suspendable
        Check if the component is marked to be executed asynchronously by using an internal Jersey executor service.
        Specified by:
        isManagedAsyncDeclared in interface Suspendable
        Returns:
        true if the component is marked for managed asynchronous execution, false otherwise.
      • isNameBound

        public boolean isNameBound()
        Description copied from interface: NameBound
        Check if the component is bound or not.
        Specified by:
        isNameBound in interface NameBound
        Returns:
        true if the component is bound, false otherwise.
      • getNameBindings

        public java.util.Collection<java.lang.Class<? extends java.lang.annotation.Annotation>> getNameBindings()
        Description copied from interface: NameBound
        Get the collection of name bindings attached to this component.
        Specified by:
        getNameBindings in interface NameBound
        Returns:
        collection of name binding annotation types.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object