org.glassfish.jersey.server.model.internal

Class ModelProcessorUtil

java.lang.Object

org.glassfish.jersey.server.model.internal.ModelProcessorUtil

public final class ModelProcessorUtil
extends Object

Helper class with methods supporting processing resource model by model processors.

Author:

Miroslav Fuksa, Michal Gajdos

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelProcessorUtil.Method Method bean containing basic information about enhancing resource method.

Method Summary

Modifier and Type	Method and Description
static void	enhanceResource(RuntimeResource resource, ResourceModel.Builder enhancedModelBuilder, List<ModelProcessorUtil.Method> methods, boolean extended) Enhance the runtime resource referenced by resource parameter with a list of additional methods.
static ResourceModel.Builder	enhanceResourceModel(ResourceModel resourceModel, boolean subResourceModel, List<ModelProcessorUtil.Method> methods, boolean extendedFlag) Enhance resourceModel with a list of additional methods.
static Set<String>	getAllowedMethods(RuntimeResource resource) Return allowed methods for the given resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAllowedMethods

public static Set<String> getAllowedMethods(RuntimeResource resource)

Return allowed methods for the given resource. OPTIONS and HEAD are always returned in the result.

Parameters:

resource - Resource for which resource methods should be found.

Returns:

Set of resource methods that can be invoked on the given resource.

enhanceResourceModel

public static ResourceModel.Builder enhanceResourceModel(ResourceModel resourceModel,
                                                         boolean subResourceModel,
                                                         List<ModelProcessorUtil.Method> methods,
                                                         boolean extendedFlag)

Enhance resourceModel with a list of additional methods. The resourceModel is traversed and for each available runtime resource URI in the model methods are added. In case of method conflicts, the existing resource methods will be preserved and will not be 'overridden' by any new method from the methods list. Overriding check takes into account media types of methods so that new resource methods with same HTTP method can be defined only for a more more specific media type.

Parameters:

resourceModel - Resource model to be enhanced.

subResourceModel - true if the resourceModel to be enhanced is a sub resource model, false if it is application resource model.

methods - List of enhancing methods.

extendedFlag - This flag will initialize the property ResourceMethod.isExtended().

Returns:

New resource model builder enhanced by methods.

enhanceResource

public static void enhanceResource(RuntimeResource resource,
                                   ResourceModel.Builder enhancedModelBuilder,
                                   List<ModelProcessorUtil.Method> methods,
                                   boolean extended)

Enhance the runtime resource referenced by resource parameter with a list of additional methods. The new methods are added to the runtime resource. In case of method conflicts, the existing resource methods will be preserved and will not be 'overridden' by any new method from the methods list. Overriding check takes into account media types of methods so that new resource methods with same HTTP method can be defined only for a more more specific media type.

Parameters:

resource - Runtime resource to be enhanced.

enhancedModelBuilder - Builder for the enhanced resource model to be used.

methods - List of enhancing methods.

extended - This flag will initialize the property ResourceMethod.isExtended().