Package org.apache.juneau.rest.server.arg

Interface RestOpArg

All Known Implementing Classes:
AttributeArg, AuthArg, ContentArg, DefaultArg, FormDataArg, HasFormDataArg, HasQueryArg, HeaderArg, HttpServletRequestArgs, HttpServletResponseArgs, HttpSessionArgs, InputStreamParserArg, MethodArg, ParserArg, PathArg, PathRemainderArg, QueryArg, ReaderParserArg, RecordReaderArg, RecordWriterArg, RequestBeanArg, ResponseBeanArg, ResponseCodeArg, ResponseHeaderArg, RestContextArgs, RestOpContextArgs, RestOpSessionArgs, RestRequestArgs, RestResponseArgs, RestSessionArgs, SimpleRestOperationArg, SseBroadcasterArg, SseSubscriptionArg, TokenReaderArg, TokenWriterArg
public interface RestOpArg
REST java method parameter resolver.

Used to resolve parameter values when invoking RestOp-annotated methods.

Example:

// A simple parameter resolver that resolves TimeZone parameters from the Time-Zone header. // (TimeZone parameters are already resolved out-of-the-box; this is purely illustrative.) public class TimeZoneArg implements RestOpArg { // Implementers must provide a static creator method that returns a RestParam if it's // applicable to the specified parameter. public static TimeZoneArg create(ParameterInfo paramInfo) { if (paramInfo.isType(TimeZone.class)) return new TimeZoneArg(); return null; } protected TimeZoneArg() {} @Override public Object resolve(RestOpSession opSession) throws Exception { return opSession.getRequest().getTimeZone().orElse(null); } }

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    resolve(RestOpSession opSession)
    Resolves the parameter object.

  • Method Details