Javadoc Tag Reference

This section provides reference information about WebLogic Workshop's Javadoc tags.

WebLogic Workshop provides a set of custom tags based on Javadoc technology. Originally developed as a way to embed documentation into source code as comments, Javadoc is extended by WebLogic Workshop through custom tags that help to define a service's functionality. Much of the power of WebLogic Workshop Web Services is accessed via these tags, which are placed in your JWS and CTRL files.

For overview information about the tags, and how they are used within web services built with WebLogic Workshop, see Using the WebLogic Workshop Javadoc Tags.

# Tags

@jws:av-identity Tag

Specifies the target Application View for an Application View control.

@jws:av-service Tag

Specifies the Application View service associated with a method of an Application View control.

@jws:connection Tag

Specifies the data source used by a Database control.

@jws:control Tag

Specifies that the object annotated by this tag is a WebLogic Workshop control.

@jws:conversation Tag

Specifies the role a method or callback plays in a service's conversations.

@jws:context Tag

Specifies that the object annotated by this tag is a JwsContext object.

@jws:define Tag

Defines inline data that might otherwise be referenced as an external file.

@jws:ejb Tag

Specifies the target EJB's home interface for an EJB control.

@jws:parameter-xml Tag

Specifies conversion between XML messages and a Java method's parameters.

@jws:jms Tag

Specifies the configuration attributes of a JMS control.

@jws:jms-header Tag

Specifies XML maps for headers of messages processed by a JMS control.

@jws:jms-message Tag

Specifies XML maps for the message body of messages processed by a JMS control.

@jws:jms-property Tag

Specifies XML maps for properties of messages processed by a JMS control.

@jws:conversation-lifetime Tag

Specifies the maximum age and/or the maximum idle time for a service's conversations.

@jws:message-buffer Tag

Specifies that there should be a queue between the service's implementation code and the message transport mechanism for the specified method.

@jws:operation Tag

Specifies that the associated method is part of the web service's public contract and is available for clients to invoke.

@jws:protocol Tag

Specifies which protocols and message formats a web service can accept or a Service control will send to the service it represents.

@jws:return-xml Tag

Specifies conversion between XML messages and a Java method's return value.

@jws:location Tag

Specifies the URL at which a service accepts requests for each supported protocol.

@jws:schema Tag

Specifies the schema file whose types are referenced in the @jws:parameter-xml and @jws:return-xml tags elsewhere in a JWS or CTRL file.

@jws:sql Tag

Specifies the SQL statement and associated attributes that correspond to a method in a Database control.

@jws:target-namespace Tag

Specifies the default XML namespace used for outgoing XML messages and generated WSDL files.

@jws:timer Tag

Specifies configuration attributes for a Timer control.

@jws:wsdl Tag

Specifies a WSDL file that is implemented by a web service or represented by a Service control.

@jws:xmlns Tag

Defines an XML namespace prefix for use elsewhere in a JWS file or Service control CTRL file.