1 //
2 // ========================================================================
3 // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.websocket.jsr356.annotations;
20
21 import org.eclipse.jetty.websocket.common.events.annotated.InvalidSignatureException;
22
23 /**
24 * JSR-356 Parameter Identification processing.
25 */
26 public interface IJsrParamId
27 {
28 /**
29 * Process the potential parameter.
30 * <p>
31 * If known to be a valid parameter, bind a role to it.
32 *
33 * @param param
34 * the parameter being processed
35 * @param callable
36 * the callable this param belongs to (used to obtain extra state about the callable that might impact decision making)
37 *
38 * @return true if processed, false if not processed
39 * @throws InvalidSignatureException
40 * if a violation of the signature rules occurred
41 */
42 boolean process(Param param, JsrCallable callable) throws InvalidSignatureException;
43 }