Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/developer/SchemaValidation.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/developer/SchemaValidation.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.ws.developer; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.xml.internal.ws.server.DraconianValidationErrorHandler; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import javax.jws.WebService; |
| aoqi@0 | 31 | import javax.xml.ws.spi.WebServiceFeatureAnnotation; |
| aoqi@0 | 32 | import java.lang.annotation.Documented; |
| aoqi@0 | 33 | import static java.lang.annotation.ElementType.TYPE; |
| aoqi@0 | 34 | import java.lang.annotation.Retention; |
| aoqi@0 | 35 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| aoqi@0 | 36 | import java.lang.annotation.Target; |
| aoqi@0 | 37 | import java.lang.annotation.ElementType; |
| aoqi@0 | 38 | |
| aoqi@0 | 39 | /** |
| aoqi@0 | 40 | * Validates all request and response messages payload(SOAP:Body) for a {@link WebService} |
| aoqi@0 | 41 | * against the XML schema. To use this feature, annotate the endpoint class with |
| aoqi@0 | 42 | * this annotation. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * <pre> |
| aoqi@0 | 45 | * for e.g.: |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * @WebService |
| aoqi@0 | 48 | * @SchemaValidation |
| aoqi@0 | 49 | * public class HelloImpl { |
| aoqi@0 | 50 | * ... |
| aoqi@0 | 51 | * } |
| aoqi@0 | 52 | * </pre> |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * At present, schema validation works for doc/lit web services only. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * @since JAX-WS 2.1.3 |
| aoqi@0 | 57 | * @author Jitendra Kotamraju |
| aoqi@0 | 58 | * @see SchemaValidationFeature |
| aoqi@0 | 59 | */ |
| aoqi@0 | 60 | @Retention(RUNTIME) |
| aoqi@0 | 61 | @Target({TYPE, ElementType.METHOD, ElementType.FIELD}) |
| aoqi@0 | 62 | @Documented |
| aoqi@0 | 63 | @WebServiceFeatureAnnotation(id = SchemaValidationFeature.ID, bean = SchemaValidationFeature.class) |
| aoqi@0 | 64 | public @interface SchemaValidation { |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** |
| aoqi@0 | 67 | * Configure the validation behaviour w.r.t error handling. The default handler |
| aoqi@0 | 68 | * just rejects any invalid schema intances. If the application want to change |
| aoqi@0 | 69 | * this default behaviour(say just log the errors), it can do so by providing |
| aoqi@0 | 70 | * a custom implementation of {@link ValidationErrorHandler}. |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | Class<? extends ValidationErrorHandler> handler() default DraconianValidationErrorHandler.class; |
| aoqi@0 | 73 | |
| aoqi@0 | 74 | /** |
| aoqi@0 | 75 | * Turns validation on/off for inbound messages |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * @since JAX-WS RI 2.2.2 |
| aoqi@0 | 78 | */ |
| aoqi@0 | 79 | boolean inbound() default true; |
| aoqi@0 | 80 | |
| aoqi@0 | 81 | |
| aoqi@0 | 82 | /** |
| aoqi@0 | 83 | * Turns validation on/off for outbound messages |
| aoqi@0 | 84 | * |
| aoqi@0 | 85 | * @since JAX-WS RI 2.2.2 |
| aoqi@0 | 86 | */ |
| aoqi@0 | 87 | boolean outbound() default true; |
| aoqi@0 | 88 | |
| aoqi@0 | 89 | /** |
| aoqi@0 | 90 | * Does validation for bound headers in a SOAP message. |
| aoqi@0 | 91 | * |
| aoqi@0 | 92 | boolean headers() default false; |
| aoqi@0 | 93 | */ |
| aoqi@0 | 94 | |
| aoqi@0 | 95 | /** |
| aoqi@0 | 96 | * Additional schema documents that are used to create {@link Schema} object. Useful |
| aoqi@0 | 97 | * when the application adds additional SOAP headers to the message. This is a list |
| aoqi@0 | 98 | * of system-ids, that are used to create {@link Source} objects and used in creation |
| aoqi@0 | 99 | * of {@link Schema} object |
| aoqi@0 | 100 | * |
| aoqi@0 | 101 | * for e.g.: |
| aoqi@0 | 102 | * @SchemaValidation(schemaLocations={"http://bar.foo/b.xsd", "http://foo.bar/a.xsd"} |
| aoqi@0 | 103 | * |
| aoqi@0 | 104 | String[] schemaLocations() default {}; |
| aoqi@0 | 105 | */ |
| aoqi@0 | 106 | |
| aoqi@0 | 107 | } |
