Package org.apache.cxf.jaxrs.utils

Class JAXRSUtils

java.lang.Object
org.apache.cxf.jaxrs.utils.JAXRSUtils
public final class JAXRSUtils extends Object

  • Field Details

  • Method Details

    • isStreamingLikeOutType

      public static boolean isStreamingLikeOutType(Class<?> cls, Type type)
      Consider additional types as stream-like and returns if the class and corresponding type refer to one of those.
      Parameters:
      cls - class to check
      type - type to check
      Returns:
      "true" is the class and corresponding type could be considered streaming-like, "false" otherwise.

    • isStreamingOutType

      public static boolean isStreamingOutType(Class<?> type)

    • getPathSegments

      public static List<jakarta.ws.rs.core.PathSegment> getPathSegments(String thePath, boolean decode)

    • getPathSegments

      public static List<jakarta.ws.rs.core.PathSegment> getPathSegments(String thePath, boolean decode, boolean ignoreLastSlash)
      Parses path segments taking into account the URI templates and template regexes. Per RFC-3986, "A path consists of a sequence of path segments separated by a slash ("/") character.", however it is possible to include slash ("/") inside template regex, for example "/my/path/{a:b/c}", see please URITemplate. In this case, the whole template definition is extracted as a path segment, without breaking it.
      Parameters:
      thePath - path
      decode - should the path segments be decoded or not
      ignoreLastSlash - should the last slash be ignored or not
      Returns:

    • getProviderConsumeTypes

      public static List<jakarta.ws.rs.core.MediaType> getProviderConsumeTypes(jakarta.ws.rs.ext.MessageBodyReader<?> provider)

    • getProviderProduceTypes

      public static List<jakarta.ws.rs.core.MediaType> getProviderProduceTypes(jakarta.ws.rs.ext.MessageBodyWriter<?> provider)

    • getMediaTypes

      public static List<jakarta.ws.rs.core.MediaType> getMediaTypes(String[] values)

    • injectParameters

      public static void injectParameters(OperationResourceInfo ori, Object requestObject, Message message)

    • injectParameters

      public static void injectParameters(OperationResourceInfo ori, BeanResourceInfo bri, Object requestObject, Message message)

    • selectResourceClass

      public static Map<ClassResourceInfo,jakarta.ws.rs.core.MultivaluedMap<String,String>> selectResourceClass(List<ClassResourceInfo> resources, String path, Message message)

    • findTargetMethod

      public static OperationResourceInfo findTargetMethod(Map<ClassResourceInfo,jakarta.ws.rs.core.MultivaluedMap<String,String>> matchedResources, Message message, String httpMethod, jakarta.ws.rs.core.MultivaluedMap<String,String> matchedValues, String requestContentType, List<jakarta.ws.rs.core.MediaType> acceptContentTypes)

    • findTargetMethod

      public static OperationResourceInfo findTargetMethod(Map<ClassResourceInfo,jakarta.ws.rs.core.MultivaluedMap<String,String>> matchedResources, Message message, String httpMethod, jakarta.ws.rs.core.MultivaluedMap<String,String> matchedValues, String requestContentType, List<jakarta.ws.rs.core.MediaType> acceptContentTypes, boolean throwException, boolean recordMatchedUri)

    • getExceptionLogLevel

      public static Level getExceptionLogLevel(Message message, Class<? extends jakarta.ws.rs.WebApplicationException> exClass)

    • getRootResources

      public static List<ClassResourceInfo> getRootResources(Message message)

    • noResourceMethodForOptions

      public static boolean noResourceMethodForOptions(jakarta.ws.rs.core.Response exResponse, String httpMethod)

    • createResponse

      public static jakarta.ws.rs.core.Response createResponse(List<ClassResourceInfo> cris, Message msg, String responseMessage, int status, boolean addAllow)

    • headMethodPossible

      public static boolean headMethodPossible(String expectedMethod, String httpMethod)

    • getConsumeTypes

      public static List<jakarta.ws.rs.core.MediaType> getConsumeTypes(jakarta.ws.rs.Consumes cm)

    • getConsumeTypes

      public static List<jakarta.ws.rs.core.MediaType> getConsumeTypes(jakarta.ws.rs.Consumes cm, List<jakarta.ws.rs.core.MediaType> defaultTypes)

    • getProduceTypes

      public static List<jakarta.ws.rs.core.MediaType> getProduceTypes(jakarta.ws.rs.Produces pm)

    • getProduceTypes

      public static List<jakarta.ws.rs.core.MediaType> getProduceTypes(jakarta.ws.rs.Produces pm, List<jakarta.ws.rs.core.MediaType> defaultTypes)

    • compareSortedConsumesMediaTypes

      public static int compareSortedConsumesMediaTypes(List<jakarta.ws.rs.core.MediaType> mts1, List<jakarta.ws.rs.core.MediaType> mts2, jakarta.ws.rs.core.MediaType ct)

    • compareSortedAcceptMediaTypes

      public static int compareSortedAcceptMediaTypes(List<jakarta.ws.rs.core.MediaType> mts1, List<jakarta.ws.rs.core.MediaType> mts2, List<jakarta.ws.rs.core.MediaType> acceptTypes)

    • compareSortedMediaTypes

      public static int compareSortedMediaTypes(List<jakarta.ws.rs.core.MediaType> mts1, List<jakarta.ws.rs.core.MediaType> mts2, String qs)

    • compareMethodParameters

      public static int compareMethodParameters(Class<?>[] paraList1, Class<?>[] paraList2)

    • compareMediaTypes

      public static int compareMediaTypes(jakarta.ws.rs.core.MediaType mt1, jakarta.ws.rs.core.MediaType mt2)

    • compareMediaTypes

      public static int compareMediaTypes(jakarta.ws.rs.core.MediaType mt1, jakarta.ws.rs.core.MediaType mt2, String qs)

    • compareMediaTypesQualityFactors

      public static int compareMediaTypesQualityFactors(jakarta.ws.rs.core.MediaType mt1, jakarta.ws.rs.core.MediaType mt2)

    • compareMediaTypesQualityFactors

      public static int compareMediaTypesQualityFactors(jakarta.ws.rs.core.MediaType mt1, jakarta.ws.rs.core.MediaType mt2, String qs)

    • getMediaTypeQualityFactor

      public static float getMediaTypeQualityFactor(String q)

    • processParameters

      public static List<Object> processParameters(OperationResourceInfo ori, jakarta.ws.rs.core.MultivaluedMap<String,String> values, Message message) throws IOException, jakarta.ws.rs.WebApplicationException
      Throws:
      IOException
      jakarta.ws.rs.WebApplicationException

    • createHttpParameterValue

      public static Object createHttpParameterValue(Parameter parameter, Class<?> parameterClass, Type genericParam, Annotation[] paramAnns, Message message, jakarta.ws.rs.core.MultivaluedMap<String,String> values, OperationResourceInfo ori)

    • getMatrixParams

      public static jakarta.ws.rs.core.MultivaluedMap<String,String> getMatrixParams(String path, boolean decode)

    • createBeanParamValue

      public static Object createBeanParamValue(Message m, Class<?> clazz, OperationResourceInfo ori)

    • getContextMessage

      public static Message getContextMessage(Message m)

    • createContextValue

      public static <T> T createContextValue(Message m, Type genericType, Class<T> clazz)

    • createContextResolver

      public static jakarta.ws.rs.ext.ContextResolver<?> createContextResolver(Type genericType, Message m)

    • createResourceValue

      public static Object createResourceValue(Message m, Type genericType, Class<?> clazz)

    • getStructuredParams

      public static jakarta.ws.rs.core.MultivaluedMap<String,String> getStructuredParams(String query, String sep, boolean decode, boolean decodePlus)
      Retrieve map of query parameters from the passed in message
      Returns:
      a Map of query parameters.

    • getStructuredParams

      public static void getStructuredParams(jakarta.ws.rs.core.MultivaluedMap<String,String> queries, String query, String sep, boolean decode, boolean decodePlus)

    • getStructuredParams

      public static void getStructuredParams(jakarta.ws.rs.core.MultivaluedMap<String,String> queries, String query, String sep, boolean decode, boolean decodePlus, boolean valueIsCollection)

    • readFromMessageBodyReader

      public static Object readFromMessageBodyReader(List<jakarta.ws.rs.ext.ReaderInterceptor> readers, Class<?> targetTypeClass, Type parameterType, Annotation[] parameterAnnotations, InputStream is, jakarta.ws.rs.core.MediaType mediaType, Message m) throws IOException, jakarta.ws.rs.WebApplicationException
      Throws:
      IOException
      jakarta.ws.rs.WebApplicationException

    • writeMessageBody

      public static void writeMessageBody(List<jakarta.ws.rs.ext.WriterInterceptor> writers, Object entity, Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType, jakarta.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, Message message) throws jakarta.ws.rs.WebApplicationException, IOException
      Throws:
      jakarta.ws.rs.WebApplicationException
      IOException

    • matchConsumeTypes

      public static boolean matchConsumeTypes(jakarta.ws.rs.core.MediaType requestContentType, OperationResourceInfo ori)

    • matchProduceTypes

      public static boolean matchProduceTypes(jakarta.ws.rs.core.MediaType acceptContentType, OperationResourceInfo ori)

    • matchMimeTypes

      public static boolean matchMimeTypes(jakarta.ws.rs.core.MediaType requestContentType, jakarta.ws.rs.core.MediaType acceptContentType, OperationResourceInfo ori)

    • parseMediaTypes

      public static List<jakarta.ws.rs.core.MediaType> parseMediaTypes(String types)

    • doMimeTypesIntersect

      public static boolean doMimeTypesIntersect(List<jakarta.ws.rs.core.MediaType> mimeTypesA, jakarta.ws.rs.core.MediaType mimeTypeB)

    • doMimeTypesIntersect

      public static boolean doMimeTypesIntersect(List<jakarta.ws.rs.core.MediaType> requiredMediaTypes, List<jakarta.ws.rs.core.MediaType> userMediaTypes)

    • intersectMimeTypes

      public static List<jakarta.ws.rs.core.MediaType> intersectMimeTypes(List<jakarta.ws.rs.core.MediaType> requiredMediaTypes, List<jakarta.ws.rs.core.MediaType> userMediaTypes, boolean addRequiredParamsIfPossible)
      intersect two mime types
      Parameters:
      requiredMediaTypes -
      userMediaTypes -
      addRequiredParamsIfPossible -
      Returns:
      return a list of intersected mime types

    • intersectMimeTypes

      public static List<jakarta.ws.rs.core.MediaType> intersectMimeTypes(List<jakarta.ws.rs.core.MediaType> requiredMediaTypes, List<jakarta.ws.rs.core.MediaType> userMediaTypes, boolean addRequiredParamsIfPossible, boolean addDistanceParameter)

    • intersectMimeTypes

      public static List<jakarta.ws.rs.core.MediaType> intersectMimeTypes(List<jakarta.ws.rs.core.MediaType> mimeTypesA, jakarta.ws.rs.core.MediaType mimeTypeB)

    • intersectMimeTypes

      public static List<jakarta.ws.rs.core.MediaType> intersectMimeTypes(String mimeTypesA, String mimeTypesB)

    • sortMediaTypes

      public static List<jakarta.ws.rs.core.MediaType> sortMediaTypes(String mediaTypes, String qs)

    • sortMediaTypes

      public static List<jakarta.ws.rs.core.MediaType> sortMediaTypes(List<jakarta.ws.rs.core.MediaType> types, String qs)

    • convertFaultToResponse

      public static <T extends Throwable> jakarta.ws.rs.core.Response convertFaultToResponse(T ex, Message currentMessage)

    • setMessageContentType

      public static void setMessageContentType(Message message, jakarta.ws.rs.core.Response response)

    • getClassQName

      public static QName getClassQName(Class<?> type)

    • convertStringToQName

      public static QName convertStringToQName(String name)

    • runContainerRequestFilters

      public static boolean runContainerRequestFilters(ServerProviderFactory pf, Message m, boolean preMatch, Set<String> names) throws IOException
      Throws:
      IOException

    • runContainerResponseFilters

      public static void runContainerResponseFilters(ServerProviderFactory pf, ResponseImpl r, Message m, OperationResourceInfo ori, Method invoked) throws IOException, Throwable
      Throws:
      IOException
      Throwable

    • mediaTypeToString

      public static String mediaTypeToString(jakarta.ws.rs.core.MediaType mt, String... ignoreParams)

    • toMediaType

      public static jakarta.ws.rs.core.MediaType toMediaType(String value)

    • toResponse

      public static jakarta.ws.rs.core.Response toResponse(int status)

    • toResponse

      public static jakarta.ws.rs.core.Response toResponse(jakarta.ws.rs.core.Response.Status status)

    • toResponseBuilder

      public static jakarta.ws.rs.core.Response.ResponseBuilder toResponseBuilder(int status)

    • toResponseBuilder

      public static jakarta.ws.rs.core.Response.ResponseBuilder toResponseBuilder(jakarta.ws.rs.core.Response.Status status)

    • fromResponse

      public static jakarta.ws.rs.core.Response.ResponseBuilder fromResponse(jakarta.ws.rs.core.Response response)

    • fromResponse

      public static jakarta.ws.rs.core.Response.ResponseBuilder fromResponse(jakarta.ws.rs.core.Response response, boolean copyEntity)

    • copyResponseIfNeeded

      public static jakarta.ws.rs.core.Response copyResponseIfNeeded(jakarta.ws.rs.core.Response response)

    • getCurrentMessage

      public static Message getCurrentMessage()

    • getRootResource

      public static ClassResourceInfo getRootResource(Message m)

    • pushOntoStack

      public static void pushOntoStack(OperationResourceInfo ori, jakarta.ws.rs.core.MultivaluedMap<String,String> params, Message msg)

    • logMessageHandlerProblem

      public static String logMessageHandlerProblem(String name, Class<?> cls, jakarta.ws.rs.core.MediaType ct)

    • getUriTemplate

      public static String getUriTemplate(Message message, ClassResourceInfo cri, OperationResourceInfo ori, OperationResourceInfo subOri)
      Get path URI template, combining base path, class & method & subresource templates
      Parameters:
      message - message instance
      cri - class resource info
      ori - operation resource info
      subOri - operation subresource info
      Returns:
      the URI template for the method in question

    • getUriTemplate

      public static String getUriTemplate(Message message, ClassResourceInfo cri, OperationResourceInfo ori)
      Get path URI template, combining base path, class & method templates
      Parameters:
      message - message instance
      cri - class resource info
      ori - operation resource info
      Returns:
      the URI template for the method in question