[jbossws-commits] JBossWS SVN: r14258 - in api/trunk/src/main/java/org/jboss: ws/api/annotation and 2 other directories.

Author: richard.opalka(a)jboss.com Date: 2011-05-05 09:51:45 -0400 (Thu, 05 May 2011) New Revision: 14258 Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/ api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java api/trunk/src/main/java/org/jboss/ws/api/binding/ api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java Removed: api/trunk/src/main/java/org/jboss/wsf/spi/annotation/ api/trunk/src/main/java/org/jboss/wsf/spi/binding/ Log: [JBWS-3289] refactoring packages - org.jboss.wsf.spi.binding -> org.jboss.ws.api.binding; org.jboss.wsf.spi.annotation -> org.jboss.ws.api.annotation Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,83 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.annotation; + +import org.jboss.logging.Logger; + +/** + * The authMethod is used to configure the authentication mechanism for the web service. + * As a prerequisite to gaining access to any web service which are protected by an + * authorization constraint, a user must have authenticated using the configured mechanism. + * + * @author ropalka(a)redhat.com + */ +public final class AuthMethod +{ + private static final Logger log = Logger.getLogger(AuthMethod.class); + + /** + * Basic authentication. + */ + public static final String BASIC = "BASIC"; + /** + * Client certificate based authentication. + */ + public static final String CLIENT_CERT = "CLIENT-CERT"; + + /** + * Forbidden constructor. + */ + private AuthMethod() + { + super(); + } + + /** + * Returns string representing correct auth method value. + * @param s string to convert. + * @return correct auth method value + * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or it contains unknown value. + */ + public static String valueOf(final String s) + { + if (s != null) + { + if (s.equals("")) + { + return s; + } + if (s.equals(AuthMethod.BASIC)) + { + return AuthMethod.BASIC; + } + if (s.equals(AuthMethod.CLIENT_CERT)) + { + return AuthMethod.CLIENT_CERT; + } + log.warn("Non-standard auth method value: " + s); + return s; + } + + throw new IllegalArgumentException("Illegal auth method value: " + s); + } + +} Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,52 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2011, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Defines an endpoint configuration. + * This annotation is valid on an endpoint implementation bean or a SEI. + * + */ +@Retention(value = RetentionPolicy.RUNTIME) +@Target(value = { ElementType.TYPE }) +public @interface EndpointConfig { + + /** + * The optional config-name element gives the configuration name that must be present in + * the configuration given by element config-file. + * + * Default: Standard Endpoint + */ + String configName() default ""; + + /** + * The optional config-file element is a URL or resource name for the configuration. + * The default value references the current AS configuration. + * + */ + String configFile() default ""; +} Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,95 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.annotation; + +/** + * The transportGuarantee specifies that the communication + * between client and server should be NONE, INTEGRAL, or + * CONFIDENTIAL. NONE means that the application does not require any + * transport guarantees. A value of INTEGRAL means that the application + * requires that the data sent between the client and server be sent in + * such a way that it can't be changed in transit. CONFIDENTIAL means + * that the application requires that the data be transmitted in a + * fashion that prevents other entities from observing the contents of + * the transmission. In most cases, the presence of the INTEGRAL or + * CONFIDENTIAL flag will indicate that the use of SSL is required. + * + * @author ropalka(a)redhat.com + */ +public final class TransportGuarantee +{ + + /** + * Application does not require any transport guarantees. + */ + public static final String NONE = "NONE"; + /** + * Application requires that the data sent between the client and + * server be sent in such a way that it can't be changed in transit. + */ + public static final String INTEGRAL = "INTEGRAL"; + /** + * Application requires that the data be transmitted in a fashion that + * prevents other entities from observing the contents of the transmission. + */ + public static final String CONFIDENTIAL = "CONFIDENTIAL"; + + /** + * Forbidden constructor. + */ + private TransportGuarantee() + { + super(); + } + + /** + * Returns string representing correct transport guarantee value. + * @param s string to convert. + * @return correct transport guarantee value + * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or it contains unknown value. + */ + public static String valueOf(final String s) + { + if (s != null) + { + if (s.equals("")) + { + return s; + } + if (s.equals(TransportGuarantee.NONE)) + { + return TransportGuarantee.NONE; + } + if (s.equals(TransportGuarantee.INTEGRAL)) + { + return TransportGuarantee.INTEGRAL; + } + if (s.equals(TransportGuarantee.CONFIDENTIAL)) + { + return TransportGuarantee.CONFIDENTIAL; + } + } + + throw new IllegalArgumentException("Illegal transport guarantee value: " + s); + } + +} Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,98 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Provides web context specific meta data to EJB based web service endpoints. + * + * @author thomas.diesler(a)jboss.org + * @since 26-Apr-2005 + */ +@Retention(value = RetentionPolicy.RUNTIME) +@Target(value = { ElementType.TYPE }) +public @interface WebContext { + + /** + * The contextRoot element specifies the context root that the web service endpoint is deployed to. + * If it is not specified it will be derived from the deployment short name. + * + * Applies to server side port components only. + */ + String contextRoot() default ""; + + /** + * The virtual hosts that the web service endpoint is deployed to. + * + * Applies to server side port components only. + */ + String[] virtualHosts() default {}; + + /** + * Relative path that is appended to the contextRoot to form fully qualified + * endpoint address for the web service endpoint. + * + * Applies to server side port components only. + */ + String urlPattern() default ""; + + /** + * The authMethod is used to configure the authentication mechanism for the web service. + * As a prerequisite to gaining access to any web service which are protected by an authorization + * constraint, a user must have authenticated using the configured mechanism. + * + * Standard values for this element are "BASIC", or "CLIENT-CERT", custom authMethods may also + * be specified. + * + * @see AuthMethod + */ + String authMethod() default ""; + + /** + * The transportGuarantee specifies that the communication + * between client and server should be NONE, INTEGRAL, or + * CONFIDENTIAL. NONE means that the application does not require any + * transport guarantees. A value of INTEGRAL means that the application + * requires that the data sent between the client and server be sent in + * such a way that it can't be changed in transit. CONFIDENTIAL means + * that the application requires that the data be transmitted in a + * fashion that prevents other entities from observing the contents of + * the transmission. In most cases, the presence of the INTEGRAL or + * CONFIDENTIAL flag will indicate that the use of SSL is required. + * + * @see TransportGuarantee + */ + String transportGuarantee() default ""; + + /** + * A secure endpoint does not secure wsdl access by default. + * Explicitly setting secureWSDLAccess overrides this behaviour. + * + * Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723 + */ + boolean secureWSDLAccess() default false; + +} Added: api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,39 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.binding; + +import java.util.HashMap; + +/** + * Allows introduction of arbitrary binding customization properties.<p> + * This may be different between stacks and addresses meta data binding + * (i.e JSR-181 to UnifiedMetaData) as well as JAVA to XML binding operations. + * <p> + * Supported properties need to be documented in subclasses. + * + * @author Heiko.Braun(a)jboss.com + * Created: Jun 28, 2007 + */ +public abstract class BindingCustomization extends HashMap +{ + +} Added: api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java 2011-05-05 13:51:45 UTC (rev 14258) @@ -0,0 +1,36 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.api.binding; + +import org.jboss.ws.api.binding.BindingCustomization; + +/** + * JAXB customizations. + * + * @author alessio.soldano(a)jboss.com + * @since 05-Oct-2009 + */ +public class JAXBBindingCustomization extends BindingCustomization +{ + private static final long serialVersionUID = 5547146387872057974L; + +}