[jbossws-commits] JBossWS SVN: r19596 - in spi/trunk: src/main/java/org/jboss/wsf/spi and 9 other directories.

Author: rsearls Date: 2015-03-23 11:38:24 -0400 (Mon, 23 Mar 2015) New Revision: 19596 Modified: spi/trunk/pom.xml spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProvider.java spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProviderResolver.java spi/trunk/src/main/java/org/jboss/wsf/spi/classloading/ClassLoaderProvider.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ArchiveDeployment.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Deployment.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/DeploymentAspectManager.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Endpoint.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/EndpointType.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Extensible.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/HttpEndpoint.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/LifecycleHandler.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ResourceResolver.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/UnifiedVirtualFile.java spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/WSFServlet.java spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/HandlerCallback.java spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/InvocationHandler.java spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/RequestHandler.java spi/trunk/src/main/java/org/jboss/wsf/spi/management/CommonConfigStore.java spi/trunk/src/main/java/org/jboss/wsf/spi/management/EndpointRegistry.java spi/trunk/src/main/java/org/jboss/wsf/spi/management/ServerConfig.java spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/DescriptorParser.java spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/j2ee/serviceref/UnifiedPortComponentRefMetaData.java spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/webservices/WebserviceDescriptionMetaData.java spi/trunk/src/main/java/org/jboss/wsf/spi/security/SecurityDomainContext.java spi/trunk/src/main/java/org/jboss/wsf/spi/util/StAXUtils.java Log: "[JBWS-3878] resolve javaDoc warnings for jdk8 and 7" Modified: spi/trunk/pom.xml =================================================================== --- spi/trunk/pom.xml 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/pom.xml 2015-03-23 15:38:24 UTC (rev 19596) @@ -31,6 +31,7 @@ <jboss-logging-processor.version>1.0.3.Final</jboss-logging-processor.version> <servlet.api.version>1.0.2.Final</servlet.api.version> <junit.version>3.8.2</junit.version> + <jboss-logging-annotations.version>1.2.0.Final</jboss-logging-annotations.version> </properties> <!-- Dependencies --> @@ -67,6 +68,11 @@ <version>${jboss-logging-processor.version}</version> <scope>provided</scope> </dependency> + <dependency> + <groupId>org.jboss.logging</groupId> + <artifactId>jboss-logging-annotations</artifactId> + <version>${jboss-logging-annotations.version}</version> + </dependency> <!-- test dependencies --> <dependency> @@ -77,6 +83,20 @@ </dependency> </dependencies> + <!-- Disable javadoc warnings in jdk 1.8. jdk 1.7 does not support this --> + <!-- rls + <profiles> + <profile> + <id>doclint-java8-disable</id> + <activation> + <jdk>[1.8,)</jdk> + </activation> + <properties> + <javadoc.opts>-Xdoclint:none</javadoc.opts> + </properties> + </profile> + </profiles> + --> <!-- Plugins --> <build> <plugins> @@ -92,13 +112,23 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.8</version> + <version>2.9.1</version> <!-- 2.8 rls --> <executions> <execution> <phase>package</phase> <goals> <goal>jar</goal> </goals> + <!-- ${javadoc.opts} --> + <!-- + <configuration> + <additionalparam>-Xdoclint:none</additionalparam> + </configuration> + + <configuration> + <failOnError>false</failOnError> + </configuration> + --> </execution> </executions> </plugin> Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProvider.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProvider.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProvider.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -37,7 +37,7 @@ * Gets the a singleton reference to the SPIProvider returned by the SPIProviderResolver * retrieved using the default server integration classloader. * - * @return + * @return this class instance */ public static SPIProvider getInstance() { @@ -52,9 +52,9 @@ /** * Gets the specified SPI, using the current thread context classloader * - * @param <T> - * @param spiType - * @return + * @param <T> type of spi class + * @param spiType spi class to retrieve + * @return object */ public <T> T getSPI(Class<T> spiType) { @@ -64,10 +64,10 @@ /** * Gets the specified SPI, using the provided classloader * - * @param <T> - * @param spiType - * @param loader - * @return + * @param <T> type of spi class + * @param spiType spi class to retrieve + * @param loader classloader to user + * @return object */ public abstract <T> T getSPI(Class<T> spiType, ClassLoader loader); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProviderResolver.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProviderResolver.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/SPIProviderResolver.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -36,7 +36,7 @@ /** * Get the SPIProviderResolver instance using the thread context classloader for lookup * - * @return + * @return instance of this class */ public static SPIProviderResolver getInstance() { @@ -45,8 +45,9 @@ /** * Get the SPIProviderResolver instance using the provided classloader for lookup - * - * @return + * + * @param cl classloader to use for lookup + * @return instance of this class */ public static SPIProviderResolver getInstance(ClassLoader cl) { Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/classloading/ClassLoaderProvider.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/classloading/ClassLoaderProvider.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/classloading/ClassLoaderProvider.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -78,21 +78,21 @@ /** * Return the ClassLoader instance having visibility over the application server ws subsystem only * - * @return + * @return classloader */ public abstract ClassLoader getWebServiceSubsystemClassLoader(); /** * Return the ClassLoader instance having visibility over the all server side ws libraries (for JAXWS usage) * - * @return + * @return classloader */ public abstract ClassLoader getServerIntegrationClassLoader(); /** * Return the ClassLoader instance having visibility over the all server side ws libraries (for JAXRPC usage) * - * @return + * @return classloader */ public abstract ClassLoader getServerJAXRPCIntegrationClassLoader(); Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ArchiveDeployment.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ArchiveDeployment.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ArchiveDeployment.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -31,22 +31,40 @@ */ public interface ArchiveDeployment extends Deployment { - /** Get the optional parent of this deployment */ + /** + * Get the optional parent of this deployment + * @return parent of the deployment + */ ArchiveDeployment getParent(); - /** Get the root file for this deployment */ + /** + * Get the root file for this deployment + * @return root file of the deployment + */ UnifiedVirtualFile getRootFile(); - - /** The concatenated names including all parents. */ + + /** + * The concatenated names including all parents. + * @return concatenated names + */ String getCanonicalName(); - - /** Get additional metadata files attached to the deployment **/ + + /** + * Get additional metadata files attached to the deployment + * @return metadata files attached to the deployment + */ List<UnifiedVirtualFile> getMetadataFiles(); - - /** Add additional metadata file to the deployment **/ + + /** + * Add additional metadata file to the deployment + * @param file metadata file to the deployment + */ void addMetadataFile(UnifiedVirtualFile file); - - /** Get the resource resolver to be used to access resources from this archive */ + + /** + * Get the resource resolver to be used to access resources from this archive + * @return resource resolver + */ ResourceResolver getResourceResolver(); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Deployment.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Deployment.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Deployment.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -28,12 +28,33 @@ */ public interface Deployment extends Extensible { - /** Get the identifier for this deployment */ + /** + * Get the identifier for this deployment + * @return deployment identifier + */ String getSimpleName(); - /** Get the class loader for this deployment */ + /** + * Get the class loader for this deployment + * @return class loader for the deployment + */ ClassLoader getClassLoader(); - - /** Get the service associated with this deployment */ + + /** + * Get the deployment type + * @return deployment type + */ + DeploymentType getType(); + + /** + * Set the deployment type + * @param type deployment type + */ + void setType(DeploymentType type); + + /** + * Get the service associated with this deployment + * @return service for the deployment + */ Service getService(); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/DeploymentAspectManager.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/DeploymentAspectManager.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/DeploymentAspectManager.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -32,18 +32,33 @@ */ public interface DeploymentAspectManager { - /** Get the name for this aspect manager */ + /** + * Get the name for this aspect manager + * @return name of aspect manager + */ String getName(); - - /** Get the list of registered deployment aspects */ + + /** + * Get the list of registered deployment aspects + * @return list of registered deployment aspects + */ List<DeploymentAspect> getDeploymentAspects(); - - /** Set the list of registered deployment aspects */ + + /** + * Set the list of registered deployment aspects + * @param aspects set of registered deployment aspects + */ void setDeploymentAspects(List<DeploymentAspect> aspects); - /** Deploy a web service */ + /** + * Deploy a web service + * @param dep web service to deploy + */ void deploy(Deployment dep); - /** Undeploy a web service */ + /** + * Undeploy a web service + * @param dep web service deployment + */ void undeploy(Deployment dep); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Endpoint.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Endpoint.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Endpoint.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -48,99 +48,226 @@ static final String SEPID_DOMAIN_ENDPOINT = SEPID_DOMAIN + "." + SEPID_PROPERTY_ENDPOINT; - /** Get the service this endpoint belongs to */ + /** + * Get the service this endpoint belongs to + * + * @return endpoint service + */ Service getService(); - /** Set the service this endpoint belongs to */ + /** + * Set the service this endpoint belongs to + * + * @param service endpoint service + */ void setService(Service service); - /** Get the unique identifier for this endpoint */ + /** + * Get the unique identifier for this endpoint + * + * @return endpoint identifier + */ ObjectName getName(); - /** Set the unique identifier for this endpoint */ + /** + * Set the unique identifier for this endpoint + * + * @param epName endpoint identifier + */ void setName(ObjectName epName); - /** Get the short name for this endpoint */ + /** + * Get the short name for this endpoint + * + * @return endpoint short name + */ String getShortName(); - /** Set the short name for this endpoint */ + /** + * Set the short name for this endpoint + * + * @param shortName endpoint short name + */ void setShortName(String shortName); - /** Get the current state for this endpoint */ + /** + * Get the current state for this endpoint + * + * @return endpoint state + */ EndpointState getState(); - /** Set the current state for this endpoint */ + /** + * Set the current state for this endpoint + * + * @param state endpoint state + */ void setState(EndpointState state); - /** Get endpoint type */ + /** + * Get endpoint type + * + * @return endpoint type + */ EndpointType getType(); - /** Set endpoint type */ + /** + * Set endpoint type + * + * @param type endpoint type + */ void setType(EndpointType type); - /** Get the endpoint implementation bean */ + /** + * Get the endpoint implementation bean + * + * @return name of endpoint bean + */ String getTargetBeanName(); - /** Set the endpoint implementation bean */ + /** + * Set the endpoint implementation bean + * + * @param epImpl name of endpoint bean + */ void setTargetBeanName(String epImpl); - /** Use the deployment classloader to load the bean */ + /** + * Use the deployment classloader to load the bean + * + * @return bean loaded + */ Class<?> getTargetBeanClass(); - /** Set the request handler for this endpoint */ + /** + * Set the request handler for this endpoint + * + * @param handler endpoint request handler + */ void setRequestHandler(RequestHandler handler); - /** Get the request handler for this endpoint */ + /** + * Get the request handler for this endpoint + * + * @return endpoint request handler + */ RequestHandler getRequestHandler(); - /** Get the lifecycle handler for this endpoint */ + /** + * Get the lifecycle handler for this endpoint + * + * @return endpoint lifecycle handler + */ LifecycleHandler getLifecycleHandler(); - /** Set the lifecycle handler for this endpoint */ + /** + * Set the lifecycle handler for this endpoint + * + * @param handler endpoint lifecycle handler + */ void setLifecycleHandler(LifecycleHandler handler); - /** Get the endpoint bean invoker */ + /** + * Get the endpoint bean invoker + * + * @return endpoint invoker + */ InvocationHandler getInvocationHandler(); - /** Set the endpoint bean invoker */ + /** + * Set the endpoint bean invoker + * + * @param invoker endpoint invoker + */ void setInvocationHandler(InvocationHandler invoker); - /** Get the endpoint metrics for this endpoint */ + /** + * Get the endpoint metrics for this endpoint + * + * @return endpoint metrics + */ EndpointMetrics getEndpointMetrics(); - /** Set the endpoint metrics for this endpoint */ + /** + * Set the endpoint metrics for this endpoint + * + * @param metrics endpoint metrics + */ void setEndpointMetrics(EndpointMetrics metrics); - /** Get the record processors configured for this endpoint **/ + /** + * Get the record processors configured for this endpoint + * + * @return set of endpoint record processors + */ List<RecordProcessor> getRecordProcessors(); - /** Set the record processors for this endpoint **/ + /** + * Set the record processors for this endpoint + * + * @param recordProcessors set of endpoint record processors + */ void setRecordProcessors(List<RecordProcessor> recordProcessors); - /** Ask configured processors for processing of the given record **/ + /** + * Ask configured processors for processing of the given record + * + * @param record record to process + */ void processRecord(Record record); - /** Get endpoint address */ + /** + * Get endpoint address + * + * @return endpoint address + */ String getAddress(); - /** Set endpoint address */ + /** + * Set endpoint address + * + * @param address endpoint address + */ void setAddress(String address); - /** Get security domain context */ + /** + * Get security domain context + * + * @return security domain context + */ SecurityDomainContext getSecurityDomainContext(); - /** Set security domain context */ + /** + * Set security domain context + * + * @param context security domain context + */ void setSecurityDomainContext(SecurityDomainContext context); - /** Get instance provider */ + /** + * Get instance provider + * + * @return instance provider + */ InstanceProvider getInstanceProvider(); - /** Set instance provider */ + /** + * Set instance provider + * + * @param provider instance provider + */ void setInstanceProvider(InstanceProvider provider); - /** Get endpoint config */ + /** + * Get endpoint config + * + * @return endpoint config + */ EndpointConfig getEndpointConfig(); - - /** Set endpoint config */ + + /** + * Set endpoint config + * @param config endpoint config + */ void setEndpointConfig(EndpointConfig config); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/EndpointType.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/EndpointType.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/EndpointType.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -1,6 +1,6 @@ /* * JBoss, Home of Professional Open Source. - * Copyright 2014, Red Hat, Inc., and individual contributors + * Copyright 2011, Red Hat, Inc., and individual contributors * as indicated by the @author tags. See the copyright.txt file in the * distribution for a full listing of individual contributors. * @@ -29,5 +29,5 @@ */ public enum EndpointType { - JAXWS_JSE, JAXWS_EJB3 + JAXRPC_JSE, JAXRPC_EJB21, JAXWS_JSE, JAXWS_EJB3 } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Extensible.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Extensible.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/Extensible.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -33,30 +33,72 @@ */ public interface Extensible { - /** Add arbitrary attachments */ + + /** + * Add arbitrary attachments + * + * @param key identifier + * @param value value + * @param <T> class type + * @return added attachment + */ <T> T addAttachment(Class<T> key, Object value); - - /** Get arbitrary attachments */ + + /** + * Get arbitrary attachments + * + * @param <T> class type of attachments + * @return collection of attachments + */ <T> Collection<T> getAttachments(); - - /** Get an arbitrary attachment */ + + /** + * Get an arbitrary attachment + * + * @param key identifier + * @param <T> class type of attachments + * @return attachment found + */ <T> T getAttachment(Class<T> key); - - /** Remove arbitrary attachments */ + + /** + * Remove arbitrary attachments + * @param key identifier + * @param <T> class type of attachments + * @return attachment removed + */ <T> T removeAttachment(Class<T> key); - /** Get an property */ + /** + * Get an property + * + * @param key property identifier + * @return found property + */ Object getProperty(String key); - - /** Set a property */ + + /** + * Set a property + * @param key property identifier + * @param value property value + */ void setProperty(String key, Object value); - - /** Remove a property */ + + /** + * Remove a property + * @param key property identifier + */ void removeProperty(String key); - - /** Get the set of property names */ + + /** + * Get the set of property names + * @return set of property values + */ Set<String> getProperties(); - - /** Set a map of properties */ + + /** + * Set a map of properties + * @param props map to retain + */ void setProperties(Map<String, Object> props); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/HttpEndpoint.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/HttpEndpoint.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/HttpEndpoint.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -28,9 +28,17 @@ */ public interface HttpEndpoint extends Endpoint { - /** Get the URL pattern for this endpoint */ + /** + * Get the URL pattern for this endpoint + * + * @return endpoint URL pattern + */ String getURLPattern(); - /** Set the URL pattern for this endpoint */ + /** + * Set the URL pattern for this endpoint + * + * @param urlPattern endpoint URL pattern + */ void setURLPattern(String urlPattern); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/LifecycleHandler.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/LifecycleHandler.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/LifecycleHandler.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -29,9 +29,17 @@ */ public interface LifecycleHandler { - /** Handle the start step of an endpoint */ + /** + * Handle the start step of an endpoint + * + * @param endpoint endpoint to start + */ void start(Endpoint endpoint); - /** Handle the stop step of an endpoint */ + /** + * Handle the stop step of an endpoint + * + * @param endpoint endpoint to stop + */ void stop(Endpoint endpoint); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ResourceResolver.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ResourceResolver.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/ResourceResolver.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -33,11 +33,12 @@ */ public interface ResourceResolver { - /** Get the URL for a given resource path + /** + * Get the URL for a given resource path * - * @param resourcePath - * @return - * @throws IOException + * @param resourcePath resource path + * @return URL of resource + * @throws IOException IO exception */ public URL resolve(String resourcePath) throws IOException; @@ -45,8 +46,8 @@ * Same as resolve(String resourcePath) except it does not throw exception * when resource is not found, simply returns null. * - * @param resourcePath - * @return + * @param resourcePath resource path + * @return URL of resource */ public URL resolveFailSafe(String resourcePath); Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/UnifiedVirtualFile.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/UnifiedVirtualFile.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/UnifiedVirtualFile.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -40,8 +40,8 @@ * Same as findChild(String child) but does not throw any exception * on child not found, simply returns null. * - * @param child - * @return + * @param child name of child to find + * @return found child */ UnifiedVirtualFile findChildFailSafe(String child); Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/WSFServlet.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/WSFServlet.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/deployment/WSFServlet.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -66,7 +66,7 @@ * is used to lookup the factory * - otherwise the current thread context classloader is used to lookup the factory. * - * @param servletConfig + * @param servletConfig servlet config * @return the servlet delegate */ protected ServletDelegate getDelegate(ServletConfig servletConfig) Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/HandlerCallback.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/HandlerCallback.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/HandlerCallback.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -31,12 +31,31 @@ */ public interface HandlerCallback { - /** Handlers are beeing called through the HandlerCallback from the EJB interceptor */ + /** + * Handlers are being called through the HandlerCallback from the EJB interceptor + * + * @param wsInv invocation handler + * @param type handler + * @return true success + */ boolean callRequestHandlerChain(Invocation wsInv, HandlerType type); - /** Handlers are beeing called through the HandlerCallback from the EJB interceptor */ + /** + * Handlers are being called through the HandlerCallback from the EJB interceptor + * + * @param wsInv invocation handler + * @param type handler + * @return true success + */ boolean callResponseHandlerChain(Invocation wsInv, HandlerType type); - /** Handlers are beeing called through the HandlerCallback from the EJB interceptor */ + /** + * Handlers are being called through the HandlerCallback from the EJB interceptor + * + * @param wsInv invocation handler + * @param type handler + * @param ex exception + * @return true success + */ boolean callFaultHandlerChain(Invocation wsInv, HandlerType type, Exception ex); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/InvocationHandler.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/InvocationHandler.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/InvocationHandler.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -36,13 +36,27 @@ */ public abstract class InvocationHandler { - /** Create a container specific invocation */ + /** + * Create a container specific invocation + * + * @return invocation + */ public abstract Invocation createInvocation(); - /** Invoke the the service endpoint */ + /** + * Invoke the the service endpoint + * + * @param ep endpoint + * @param inv invocation + * @throws Exception exception + */ public abstract void invoke(Endpoint ep, Invocation inv) throws Exception; - /** Initilize the invocation handler */ + /** + * Initilize the invocation handler + * + * @param ep endpoint + */ public abstract void init(Endpoint ep); protected void handleInvocationException(Throwable th) throws Exception Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/RequestHandler.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/RequestHandler.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/invocation/RequestHandler.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -38,7 +38,15 @@ */ public interface RequestHandler { - /** Handle a web service http request + /** + * Handle a web service http request + * + * @param endpoint endpoint + * @param req request + * @param res response + * @param context context + * @throws ServletException exception + * @throws IOException exception */ void handleHttpRequest(Endpoint endpoint, HttpServletRequest req, HttpServletResponse res, ServletContext context) throws ServletException, IOException; } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/management/CommonConfigStore.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/management/CommonConfigStore.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/management/CommonConfigStore.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -37,14 +37,14 @@ /** * Registers a config in the store; the new config will affect runtime the first time the store is reloaded. * - * @param config + * @param config Registers a config in the store */ void register(T config); /** * Unregisters a config in the store; the runtime will be affected the first time the store is reloaded. * - * @param config + * @param config Unregisters a config in the store */ void unregister(T config); @@ -62,7 +62,7 @@ /** * Sets a wrapper config, to be merged with any registered config. * - * @param config + * @param config Sets a wrapper config * @param reload Whether to reload the store after having set the wrapper or not */ void setWrapperConfig(T config, boolean reload); @@ -70,22 +70,22 @@ /** * Returns current wrapper config * - * @return + * @return Returns current wrapper config */ T getWrapperConfig(); /** * Retrieves a config by name from the loaded collection * - * @param name - * @return + * @param name Retrieves a config by name + * @return The matching config */ T getConfig(String name); /** * Returns the loaded config collection * - * @return + * @return the config collection */ Collection<T> getConfigs(); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/management/EndpointRegistry.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/management/EndpointRegistry.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/management/EndpointRegistry.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -37,15 +37,30 @@ */ public interface EndpointRegistry { - /** Get the list of registered endpoints */ + /** + * Get the list of registered endpoints + * @return list of registered endpoints + */ Set<ObjectName> getEndpoints(); - /** Get the registered endpoint */ + /** + * Get the registered endpoint + * @param epName endpoint to return + * @return registered endpoint + */ Endpoint getEndpoint(ObjectName epName); - /** Resolve endpoints thrrough a resolve instance **/ + /** + * Resolve endpoints through a resolve instance + * @param resolver resolver endpoint + * @return found resolved endpoint + */ Endpoint resolve(EndpointResolver resolver); - /** True is an endpoint for that name is registered */ + /** + * True is an endpoint for that name is registered + * @param epName endpoint to lookup + * @return True if endpoint for name is registered + */ boolean isRegistered(ObjectName epName); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/management/ServerConfig.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/management/ServerConfig.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/management/ServerConfig.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -79,7 +79,7 @@ * Register a client config in the server configuration; the new config will apply to runtime when the server config is started * or after a client config store reload. * - * @param config + * @param config client config to register */ void registerClientConfig(ClientConfig config); @@ -87,7 +87,7 @@ * Unregister a client config from the server configuration; the new config will be removed from * the collection returned to callers after next endpoint store reload. * - * @param config + * @param config client config to unregister */ void unregisterClientConfig(ClientConfig config); @@ -98,8 +98,9 @@ /** * Get a client config by name - * - * @return + * + * @param name name of client config + * @return named client config */ ClientConfig getClientConfig(String name); @@ -107,7 +108,7 @@ * Register an endpoint config in the server configuration; the new config will apply to runtime when the server config is started * or after an endpoint config store reload. * - * @param config + * @param config endpoint config to register */ void registerEndpointConfig(EndpointConfig config); @@ -115,7 +116,7 @@ * Unregister an endpoint config from the server configuration; the new config will be removed from * the collection returned to callers after next endpoint store reload. * - * @param config + * @param config endpoint config to unregister */ void unregisterEndpointConfig(EndpointConfig config); @@ -126,8 +127,9 @@ /** * Get an endpoint config by name - * - * @return + * + * @param name name of endpoint + * @return found named endpoint config */ EndpointConfig getEndpointConfig(String name); /** Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/DescriptorParser.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/DescriptorParser.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/DescriptorParser.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -41,8 +41,8 @@ * Parses the descriptor at the provided URL and returns * the corresponding object (metadata) * - * @param url - * @return + * @param url url + * @return metadata */ T parse(final URL url); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/j2ee/serviceref/UnifiedPortComponentRefMetaData.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/j2ee/serviceref/UnifiedPortComponentRefMetaData.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/j2ee/serviceref/UnifiedPortComponentRefMetaData.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -148,6 +148,9 @@ * or another module in the same application unit. The syntax * for specification follows the syntax defined for ejb-link * in the EJB 2.0 specification. + + * + * @return string */ public String getPortComponentLink() { Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/webservices/WebserviceDescriptionMetaData.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/webservices/WebserviceDescriptionMetaData.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/metadata/webservices/WebserviceDescriptionMetaData.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -98,7 +98,7 @@ * Get the QNames of the port components to be declared * in the namespaces * - * @return + * @return collection of QNames */ public Collection<QName> getPortComponentQNames() { @@ -164,7 +164,7 @@ /** * Serialize as a String * - * @return + * @return string */ public String serialize() { Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/security/SecurityDomainContext.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/security/SecurityDomainContext.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/security/SecurityDomainContext.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -72,7 +72,8 @@ /** * Return the set of domain roles the principal has been assigned. - * + * + * @param principal principal * @return The <code>Set&lt;java.security.Principal&gt;</code> for the application domain roles that the principal has been assigned. */ public Set<Principal> getUserRoles(Principal principal); @@ -81,9 +82,9 @@ * Push the provided subject into the current security context; if that's not set yet, * also creates a new security context and associates it with the current thread. * - * @param subject - * @param principal - * @param credential + * @param subject subject + * @param principal principal + * @param credential credential */ public void pushSubjectContext(final Subject subject, final Principal principal, final Object credential); } Modified: spi/trunk/src/main/java/org/jboss/wsf/spi/util/StAXUtils.java =================================================================== --- spi/trunk/src/main/java/org/jboss/wsf/spi/util/StAXUtils.java 2015-03-21 00:36:11 UTC (rev 19595) +++ spi/trunk/src/main/java/org/jboss/wsf/spi/util/StAXUtils.java 2015-03-23 15:38:24 UTC (rev 19596) @@ -64,8 +64,8 @@ /** * Return a new factory so that the caller can set sticky parameters. - * @param nsAware - * @return + * @param nsAware true is nsAware + * @return XMLInputFactory */ public static XMLInputFactory createXMLInputFactory(boolean nsAware) {