### getTextStart Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the starting offset of the text content within the internal buffer. ```APIDOC ## getTextStart() ### Description Returns the starting offset of the text content within the internal buffer. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **int** - The starting offset of the text content. ``` -------------------------------- ### writeStartElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/transform/OutTransformWriter.html Writes a start element with the specified prefix, local name, and URI. ```APIDOC ## writeStartElement ### public void writeStartElement(String prefix, String local, String uri) throws XMLStreamException Writes a start element with the given prefix, local name, and URI. This method is specified by the XMLStreamWriter interface and overrides the implementation in DelegatingXMLStreamWriter. #### Parameters * **prefix** (String) - The namespace prefix for the element. * **local** (String) - The local name of the element. * **uri** (String) - The namespace URI for the element. #### Throws * XMLStreamException - If an error occurs during start element writing. ### public void writeStartElement(String uri, String local) throws XMLStreamException Writes a start element with the given URI and local name. This method is specified by the XMLStreamWriter interface and overrides the implementation in DelegatingXMLStreamWriter. #### Parameters * **uri** (String) - The namespace URI for the element. * **local** (String) - The local name of the element. #### Throws * XMLStreamException - If an error occurs during start element writing. ### public void writeStartElement(String local) throws XMLStreamException Writes a start element with the given local name. This method is specified by the XMLStreamWriter interface and overrides the implementation in DelegatingXMLStreamWriter. #### Parameters * **local** (String) - The local name of the element. #### Throws * XMLStreamException - If an error occurs during start element writing. ``` -------------------------------- ### Writing Start Elements Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/W3CDOMStreamWriter.html Methods for writing the start of an XML element. ```APIDOC ## Writing Start Elements ### writeStartElement(String local) Writes a start element with the given local name. ### writeStartElement(String namespace, String local) Writes a start element with the given namespace and local name. ### writeStartElement(String prefix, String local, String namespace) Writes a start element with the given prefix, local name, and namespace. ``` -------------------------------- ### writeStartElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/transform/IgnoreNamespacesWriter.html Writes a start element to the XML stream, potentially ignoring namespaces. ```APIDOC ## writeStartElement ### Description Writes a start element to the XML stream. This method is overridden to potentially ignore namespaces. ### Method ```java public void writeStartElement(String prefix, String local, String uri) throws XMLStreamException ``` ### Overrides `writeStartElement` in class `DelegatingXMLStreamWriter` ### Throws `XMLStreamException` --- ## writeStartElement ### Description Writes a start element to the XML stream. This method is overridden to potentially ignore namespaces. ### Method ```java public void writeStartElement(String uri, String local) throws XMLStreamException ``` ### Overrides `writeStartElement` in class `DelegatingXMLStreamWriter` ### Throws `XMLStreamException` ``` -------------------------------- ### writeStartElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/StaxUtils.html Writes a start element to the XMLStreamWriter with the specified prefix, name, and namespace. ```APIDOC ## writeStartElement ### Description Writes a start element to the XMLStreamWriter with the specified prefix, name, and namespace. ### Method static void ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response None #### Response Example None ``` -------------------------------- ### writeStartElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/PrettyPrintXMLStreamWriter.html Writes the start of a new element. This method is part of the XMLStreamWriter interface. ```APIDOC ## writeStartElement ### Description Writes the start of a new element with a local name. ### Method public void writeStartElement(String localName) throws XMLStreamException ### Parameters * **localName** (String) - The local name of the element. ### Throws * `XMLStreamException` ``` ```APIDOC ## writeStartElement ### Description Writes the start of a new element with a namespace URI and local name. ### Method public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException ### Parameters * **namespaceURI** (String) - The namespace URI of the element. * **localName** (String) - The local name of the element. ### Throws * `XMLStreamException` ``` ```APIDOC ## writeStartElement ### Description Writes the start of a new element with a prefix, local name, and namespace URI. ### Method public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException ### Parameters * **prefix** (String) - The prefix of the namespace. * **localName** (String) - The local name of the element. * **namespaceURI** (String) - The namespace URI of the element. ### Throws * `XMLStreamException` ``` -------------------------------- ### initialize Method Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/databinding/stax/StaxDataBinding.html Initializes the service info with information from the databinding. ```APIDOC ## initialize(Service service) ### Description Initializes the service info (i.e. type & element names, Schemas) with information from the databinding. ### Method `public void initialize(Service service)` ### Parameters #### Path Parameters - **service** (Service) - Description: The service to initialize. ``` -------------------------------- ### skipToStartOfElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/StaxUtils.html Checks if the current position is at the start of an element. If not, it advances to the next element start. Returns true if an element start is found, false if the end of the stream is reached. ```APIDOC ## skipToStartOfElement ### Description Checks if the current position is at the start of an element. If not, it advances to the next element start. Returns true if an element start is found, false if the end of the stream is reached. ### Method static boolean ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **return value** (boolean) - true if at the start of an element or successfully moved to the next element start, false otherwise. #### Response Example None ``` -------------------------------- ### GZIPOutInterceptor Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/common/gzip/GZIPOutInterceptor.html Provides information on how to instantiate the GZIPOutInterceptor, with options to set a compression threshold. ```APIDOC ## GZIPOutInterceptor Constructors ### Description Instantiates the GZIPOutInterceptor. You can optionally provide a compression threshold. ### Constructors - `GZIPOutInterceptor()`: Default constructor. - `GZIPOutInterceptor(int threshold)`: Constructor that accepts an integer `threshold` to specify the minimum message size (in bytes) for compression. A threshold of 0 forces compression for all messages. ``` -------------------------------- ### ChainInitiationObserver Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/ChainInitiationObserver.html Initializes a new instance of the ChainInitiationObserver class. ```APIDOC ## ChainInitiationObserver Constructor ### Description Initializes a new instance of the ChainInitiationObserver class. ### Parameters * **endpoint** (Endpoint) - The endpoint associated with the observer. * **bus** (Bus) - The Bus instance to be used. ``` -------------------------------- ### getProperty Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets a property of the XMLStreamReader. ```APIDOC ## getProperty(String name) ### Description Returns a property of the XMLStreamReader. This method is specified by the XMLStreamReader interface. ### Parameters * **name** (String) - The name of the property to retrieve. ### Method GET ### Endpoint N/A (Method call) ### Returns * **Object** - The value of the property. ``` -------------------------------- ### writeStartDocument Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DelegatingXMLStreamWriter.html Writes the XML document start. This method is part of the XMLStreamWriter interface. ```APIDOC ## writeStartDocument ### Description Writes the start of the XML document without specifying encoding or version. ### Method public void writeStartDocument() throws XMLStreamException ### Throws * XMLStreamException ``` ```APIDOC ## writeStartDocument ### Description Writes the start of the XML document with specified encoding and version. ### Method public void writeStartDocument(String encoding, String ver) throws XMLStreamException ### Parameters * **encoding** (String) - The encoding of the XML document. * **ver** (String) - The version of the XML document. ### Throws * XMLStreamException ``` ```APIDOC ## writeStartDocument ### Description Writes the start of the XML document with a specified version. ### Method public void writeStartDocument(String ver) throws XMLStreamException ### Parameters * **ver** (String) - The version of the XML document. ### Throws * XMLStreamException ``` -------------------------------- ### doInitializeProvider Method Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/feature/AbstractFeature.html Initializes the interceptor provider with the given bus. ```APIDOC ## doInitializeProvider(InterceptorProvider provider, Bus bus) ### Description Initializes the interceptor provider. This method is specified by the `AbstractPortableFeature` interface. ### Method `public void doInitializeProvider(InterceptorProvider provider, Bus bus)` ### Parameters * **provider** (`InterceptorProvider`) - The interceptor provider to initialize. * **bus** (`Bus`) - The bus to associate with the provider. ``` -------------------------------- ### getMessage Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/message/AbstractWrappedMessage.html Gets the underlying message. ```APIDOC ## getMessage ### Description Gets the underlying message. ### Method `public Message getMessage()` ### Returns the underlying message. ``` -------------------------------- ### Bus Creation Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/spring/SpringBusFactory.html Methods for creating Bus instances. These methods support various configurations, including specifying configuration files, URLs, and whether to include defaults. ```APIDOC ## Bus Creation Methods ### createBus() Creates a new bus. This is a general-purpose method to instantiate a Bus. ### createBus(String cfgFile) Creates a new bus using a single configuration file. ### createBus(String[] cfgFiles) Creates a new bus using an array of configuration files. ### createBus(String cfgFile, boolean includeDefaults) Creates a new bus using a single configuration file, with an option to include default configurations. ### createBus(String[] cfgFiles, boolean includeDefaults) Creates a new bus using an array of configuration files, with an option to include default configurations. ### createBus(URL url) Creates a new bus using a single URL. ### createBus(URL[] urls) Creates a new bus using an array of URLs. ### createBus(URL url, boolean includeDefaults) Creates a new bus using a single URL, with an option to include default configurations. ### createBus(URL[] urls, boolean includeDefaults) Creates a new bus using an array of URLs, with an option to include default configurations. ``` -------------------------------- ### getPrefix Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the prefix of the current element. ```APIDOC ## getPrefix() ### Description Returns the prefix of the current element. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The prefix of the current element. ``` -------------------------------- ### getPITarget Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the target of a processing instruction. ```APIDOC ## getPITarget() ### Description Returns the target of the current processing instruction. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The target of the processing instruction. ``` -------------------------------- ### GZIPOutInterceptor Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/common/gzip/GZIPOutInterceptor.html Constructors for initializing the GZIPOutInterceptor. ```APIDOC ## GZIPOutInterceptor() ### Description Initializes a new instance of the GZIPOutInterceptor with default settings. ### Constructor `public GZIPOutInterceptor()` ``` ```APIDOC ## GZIPOutInterceptor(int threshold) ### Description Initializes a new instance of the GZIPOutInterceptor with a specified compression threshold. ### Constructor `public GZIPOutInterceptor(int threshold)` ### Parameters * **threshold** (int) - The minimum size in bytes to trigger GZIP compression. ``` -------------------------------- ### ServiceSchemaInfo Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/model/ServiceSchemaInfo.html Initializes a new instance of the ServiceSchemaInfo class. ```APIDOC ## ServiceSchemaInfo() ### Description Initializes a new instance of the ServiceSchemaInfo class. ### Constructor `ServiceSchemaInfo()` ``` -------------------------------- ### getPIData Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the data of a processing instruction. ```APIDOC ## getPIData() ### Description Returns the data of the current processing instruction. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The data of the processing instruction. ``` -------------------------------- ### GZIPOutInterceptor Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/common/gzip/GZIPOutInterceptor.html Methods for configuring and operating the GZIPOutInterceptor. ```APIDOC ## setThreshold(int threshold) ### Description Sets the threshold for GZIP compression. ### Method `public void setThreshold(int threshold)` ### Parameters * **threshold** (int) - The minimum size in bytes to trigger GZIP compression. ``` ```APIDOC ## getThreshold() ### Description Gets the current threshold for GZIP compression. ### Method `public int getThreshold()` ### Returns * **int** - The current compression threshold. ``` ```APIDOC ## handleMessage(Message message) ### Description Intercepts a message and applies GZIP compression if applicable. ### Method `public void handleMessage(Message message)` ### Parameters * **message** (Message) - The outgoing message to intercept. ``` ```APIDOC ## gzipPermitted(Message message) ### Description Checks whether GZIP compression is permitted for the outgoing message based on headers and configuration. ### Method `public GZIPOutInterceptor.UseGzip gzipPermitted(Message message)` ### Parameters * **message** (Message) - The outgoing message. ### Returns * **GZIPOutInterceptor.UseGzip** - An enum indicating whether to attempt gzip compression. ### Throws * **Fault** - If the Accept-Encoding header does not allow any supported encoding. ``` ```APIDOC ## setForce(boolean force) ### Description Forces GZIP compression regardless of the Accept-Encoding header. ### Method `public void setForce(boolean force)` ### Parameters * **force** (boolean) - If true, GZIP compression will be forced. ``` ```APIDOC ## getSupportedPayloadContentTypes() ### Description Gets the set of supported payload content types for GZIP compression. ### Method `public Set getSupportedPayloadContentTypes()` ### Returns * **Set** - A set of supported content type strings. ``` ```APIDOC ## setSupportedPayloadContentTypes(Set supportedPayloadContentTypes) ### Description Sets the set of supported payload content types for GZIP compression. ### Method `public void setSupportedPayloadContentTypes(Set supportedPayloadContentTypes)` ### Parameters * **supportedPayloadContentTypes** (Set) - The set of content type strings to support. ``` -------------------------------- ### getEventType Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the type of the current event. ```APIDOC ## getEventType() ### Description Returns the type of the current event. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **int** - The event type. ``` -------------------------------- ### writeStartElement (pfx, name, ns) Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/CachingXmlEventWriter.html Writes a start element tag with the given prefix, name, and namespace URI. This method is specified in the XMLStreamWriter interface. ```APIDOC ## writeStartElement (pfx, name, ns) ### Description Writes a start element tag with the given prefix, name, and namespace URI. ### Method public void writeStartElement(String pfx, String name, String ns) ### Throws XMLStreamException ``` -------------------------------- ### getEncoding Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the encoding of the XML document. ```APIDOC ## getEncoding() ### Description Returns the encoding of the XML document. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The encoding of the document. ``` -------------------------------- ### ClientFaultConverter Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/interceptor/ClientFaultConverter.html Provides details on how to instantiate the ClientFaultConverter. ```APIDOC ## ClientFaultConverter() ### Description Default constructor for ClientFaultConverter. ### Constructor `ClientFaultConverter()` ## ClientFaultConverter(String phase) ### Description Constructor for ClientFaultConverter with a specified phase. ### Constructor `ClientFaultConverter(String phase)` ### Parameters #### Path Parameters * **phase** (String) - Required - The phase for this interceptor. ``` -------------------------------- ### getAttributeType Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the type of a specified attribute. ```APIDOC ## getAttributeType(int arg0) ### Description Returns the type of the attribute at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the attribute. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The type of the attribute. ``` -------------------------------- ### getAttributePrefix Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the prefix of a specified attribute. ```APIDOC ## getAttributePrefix(int arg0) ### Description Returns the prefix of the attribute at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the attribute. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The prefix of the attribute. ``` -------------------------------- ### ClassLoaderProxyService.LoadFirst Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/common/spi/ClassLoaderProxyService.LoadFirst.html Initializes a new instance of the LoadFirst class with the specified Bus. ```APIDOC ## LoadFirst(Bus bus) ### Description Initializes a new instance of the `ClassLoaderProxyService.LoadFirst` class. ### Constructor `public LoadFirst(Bus bus)` ### Parameters * **bus** (Bus) - The Bus instance to be used for initialization. ``` -------------------------------- ### getProperty Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DelegatingXMLStreamWriter.html Gets a property of the underlying XMLStreamWriter. ```APIDOC ## getProperty ### Description Gets a property of the underlying XMLStreamWriter. This method is specified by the XMLStreamWriter interface. ### Signature public Object getProperty(String name) ### Parameters * **name** (String) - The name of the property. ### Returns * **Object** - The value of the property. ``` -------------------------------- ### Constructor: AbstractFaultChainInitiatorObserver Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/interceptor/AbstractFaultChainInitiatorObserver.html Initializes a new instance of the AbstractFaultChainInitiatorObserver class with the provided Bus. ```APIDOC ## Constructor: AbstractFaultChainInitiatorObserver ### Description Initializes a new instance of the AbstractFaultChainInitiatorObserver class with the provided Bus. ### Parameters * **bus** (Bus) - The Bus instance to associate with this observer. ``` -------------------------------- ### getDataBinding Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/ServiceImpl.html Gets the DataBinding used by the service. ```APIDOC ## getDataBinding ### Description Gets the DataBinding used by the service. ### Method public DataBinding getDataBinding() ``` -------------------------------- ### getNamedWorkQueue Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/managers/WorkQueueManagerImpl.html Get the named work queue. ```APIDOC ## getNamedWorkQueue ### Description Get the named work queue. ### Method GET ### Endpoint /workqueue/{name} ### Parameters #### Path Parameters - **name** (String) - Required - The name of the work queue. ``` -------------------------------- ### Constructor Details Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/endpoint/PreexistingConduitSelector.html Detailed information about the constructors. ```APIDOC ## Constructor Details ### PreexistingConduitSelector public PreexistingConduitSelector(Conduit c) Constructor. Parameters: `c` - the pre-existing Conduit. ### PreexistingConduitSelector public PreexistingConduitSelector(Conduit c, Endpoint e) Constructor. Parameters: `c` - the pre-existing Conduit. `e` - the target Endpoint ``` -------------------------------- ### GZIPOutInterceptor Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/common/gzip/GZIPOutInterceptor.html Details the methods available for configuring and managing the GZIPOutInterceptor's behavior, including setting compression thresholds and supported content types. ```APIDOC ## GZIPOutInterceptor Methods ### Description Provides methods to interact with the GZIPOutInterceptor, allowing configuration of compression behavior and retrieval of supported content types. ### Methods - `void setThreshold(int threshold)`: Sets the compression threshold. Messages smaller than this threshold will not be compressed. Default is 1kB. - `int getThreshold()`: Retrieves the current compression threshold. - `void setForce(boolean force)`: Forces compression of all messages, regardless of size. If set to true, the threshold is ignored. - `GZIPOutInterceptor.UseGzip gzipPermitted(Message message)`: Determines whether gzip compression is permitted, required, or not allowed for the given message based on request headers (e.g., Accept-Encoding) and interceptor configuration. - `Set getSupportedPayloadContentTypes()`: Returns a set of content types that this interceptor can process for compression. - `void setSupportedPayloadContentTypes(Set supportedPayloadContentTypes)`: Sets the content types that this interceptor will consider for compression. ``` -------------------------------- ### getExposedJAXBContext Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/VersionTransformer.html Gets the JAXBContext for a specific WS-Addressing version. ```APIDOC ## getExposedJAXBContext ### Description Gets the JAXBContext for the exposed namespace URI. ### Method public static jakarta.xml.bind.JAXBContext getExposedJAXBContext(String exposedURI) throws jakarta.xml.bind.JAXBException ### Parameters #### Path Parameters - **exposedURI** (String) - Specifies the version WS-Addressing. ### Returns #### Success Response - **return** (jakarta.xml.bind.JAXBContext) - JAXBContext for the exposed namespace URI. ### Throws - **jakarta.xml.bind.JAXBException** - If there is an error creating the JAXBContext. ``` -------------------------------- ### getAddress Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Get the address from the provided endpoint reference. ```APIDOC ## Method Details ### getAddress `public static String getAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref)` Get the address from the provided endpoint reference. Parameters: * `ref` - - the endpoint reference Returns: String the address of the endpoint ``` -------------------------------- ### BindingFaultInfo Constructors and Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/model/BindingFaultInfo.html Details of the constructors and methods available for the BindingFaultInfo class. ```APIDOC ## Class: BindingFaultInfo ### Description Represents fault information within a binding operation in Apache CXF. ### Constructor #### BindingFaultInfo(FaultInfo f, BindingOperationInfo info) * **f** (FaultInfo) - The FaultInfo object. * **info** (BindingOperationInfo) - The BindingOperationInfo object. ### Methods #### getFaultInfo() * **Returns**: FaultInfo - The associated FaultInfo object. #### getBindingOperation() * **Returns**: BindingOperationInfo - The associated BindingOperationInfo object. ``` -------------------------------- ### getPortQName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Gets the port QName from an endpoint reference. ```APIDOC ## Method Details ### getPortQName `public static QName getPortQName(org.apache.cxf.ws.addressing.EndpointReferenceType ref, Bus bus)` ``` -------------------------------- ### ServerRegistryImpl Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/managers/ServerRegistryImpl.html Constructors for creating a new ServerRegistryImpl instance. ```APIDOC ## ServerRegistryImpl() ### Description Creates a new ServerRegistryImpl instance. ### Constructor `ServerRegistryImpl()` ``` ```APIDOC ## ServerRegistryImpl(Bus b) ### Description Creates a new ServerRegistryImpl instance with a specific Bus. ### Constructor `ServerRegistryImpl(Bus b)` ``` -------------------------------- ### getVersion Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the version of the XML specification being followed. ```APIDOC ## getVersion() ### Description Returns the version of the XML specification being followed. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The XML version. ``` -------------------------------- ### getTextCharacters Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the text content as a character array. ```APIDOC ## getTextCharacters() ### Description Returns the text content of the current event as a character array. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **char[]** - The text content as a character array. ``` -------------------------------- ### GZIPFeature.Portable Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/transport/common/gzip/GZIPFeature.Portable.html Initializes a new instance of the GZIPFeature.Portable class. ```APIDOC ## Constructor ### `Portable()` Initializes a new instance of the `GZIPFeature.Portable` class. ``` -------------------------------- ### getNamespacePrefix Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the prefix of a namespace declaration by index. ```APIDOC ## getNamespacePrefix(int arg0) ### Description Returns the prefix of the namespace declaration at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the namespace declaration. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The prefix of the namespace declaration. ``` -------------------------------- ### AbstractDescriptionElement Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/model/AbstractDescriptionElement.html Initializes a new instance of the AbstractDescriptionElement class. ```APIDOC ## AbstractDescriptionElement() ### Description Initializes a new instance of the AbstractDescriptionElement class. ### Constructor `AbstractDescriptionElement()` ``` -------------------------------- ### AbstractWrappedOutputStream Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/io/AbstractWrappedOutputStream.html Provides details on how to instantiate AbstractWrappedOutputStream. ```APIDOC ## Constructors ### `protected AbstractWrappedOutputStream()` Default constructor. ### `protected AbstractWrappedOutputStream(OutputStream os)` Constructor that takes an OutputStream to wrap. ``` -------------------------------- ### getName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the qualified name of the current element. ```APIDOC ## getName() ### Description Returns the qualified name (QName) of the current element. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **QName** - The qualified name of the current element. ``` -------------------------------- ### BindingMessageInfo Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/model/BindingMessageInfo.html Provides details on how to instantiate a BindingMessageInfo object. ```APIDOC ## Constructor Summary Constructors Modifier | Constructor | Description ------- | -------- | -------- ` ` | `BindingMessageInfo()` | Creates a new instance of BindingMessageInfo. `protected ` | `BindingMessageInfo(MessageInfo m, BindingOperationInfo boi)` | Creates a new instance of BindingMessageInfo with the specified MessageInfo and BindingOperationInfo. ``` -------------------------------- ### getLocalName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the local name of the current element. ```APIDOC ## getLocalName() ### Description Returns the local name of the current element. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The local name of the current element. ``` -------------------------------- ### getAttributeNamespace Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the namespace URI of a specified attribute. ```APIDOC ## getAttributeNamespace(int arg0) ### Description Returns the namespace URI of the attribute at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the attribute. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The namespace URI of the attribute. ``` -------------------------------- ### BusApplicationContext Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/spring/BusApplicationContext.html Provides details on the various ways to construct a BusApplicationContext instance. ```APIDOC ## BusApplicationContext Constructors ### BusApplicationContext public BusApplicationContext(String cf, boolean include) ### BusApplicationContext public BusApplicationContext(String[] cfs, boolean include) ### BusApplicationContext public BusApplicationContext(URL url, boolean include) ### BusApplicationContext public BusApplicationContext(URL[] urls, boolean include) ### BusApplicationContext public BusApplicationContext(String cf, boolean include, org.springframework.context.ApplicationContext parent) ### BusApplicationContext public BusApplicationContext(URL url, boolean include, org.springframework.context.ApplicationContext parent) ### BusApplicationContext public BusApplicationContext(String[] cf, boolean include, org.springframework.context.ApplicationContext parent) ### BusApplicationContext public BusApplicationContext(String[] cf, boolean include, org.springframework.context.ApplicationContext parent, org.springframework.beans.factory.xml.NamespaceHandlerResolver res) ### BusApplicationContext public BusApplicationContext(URL[] url, boolean include, org.springframework.context.ApplicationContext parent) ### BusApplicationContext public BusApplicationContext(URL[] url, boolean include, org.springframework.context.ApplicationContext parent, org.springframework.beans.factory.xml.NamespaceHandlerResolver res) ``` -------------------------------- ### getAttributeName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the qualified name of a specified attribute. ```APIDOC ## getAttributeName(int arg0) ### Description Returns the qualified name (QName) of the attribute at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the attribute. ### Method GET ### Endpoint N/A (Method call) ### Returns * **QName** - The qualified name of the attribute. ``` -------------------------------- ### getAttributeLocalName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the local name of a specified attribute. ```APIDOC ## getAttributeLocalName(int arg0) ### Description Returns the local name of the attribute at the specified index. This method is specified by the XMLStreamReader interface. ### Parameters * **arg0** (int) - The index of the attribute. ### Method GET ### Endpoint N/A (Method call) ### Returns * **String** - The local name of the attribute. ``` -------------------------------- ### CXFBusFactory Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/CXFBusFactory.html Provides details on how to instantiate the CXFBusFactory. ```APIDOC ## CXFBusFactory() ### Description Constructs a new CXFBusFactory. ### Constructor `CXFBusFactory()` ``` -------------------------------- ### getAttributeCount Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Gets the number of attributes on the current element. ```APIDOC ## getAttributeCount() ### Description Returns the number of attributes on the current element. This method is specified by the XMLStreamReader interface. ### Method GET ### Endpoint N/A (Method call) ### Returns * **int** - The number of attributes. ``` -------------------------------- ### ClientOutFaultObserver Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/interceptor/ClientOutFaultObserver.html Constructs a new ClientOutFaultObserver with the given Bus. ```APIDOC ## ClientOutFaultObserver(Bus bus) ### Description Constructs a new ClientOutFaultObserver. ### Parameters * **bus** (Bus) - The Bus instance to use. ``` -------------------------------- ### getExecutor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/ServiceImpl.html Gets the Executor used for asynchronous operations. ```APIDOC ## getExecutor ### Description Gets the Executor used for asynchronous operations. ### Method public Executor getExecutor() ``` -------------------------------- ### writeStartElement (name, ns) Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/CachingXmlEventWriter.html Writes a start element tag with the given name and namespace URI. This method is specified in the XMLStreamWriter interface. ```APIDOC ## writeStartElement (name, ns) ### Description Writes a start element tag with the given name and namespace URI. ### Method public void writeStartElement(String name, String ns) ### Throws XMLStreamException ``` -------------------------------- ### getName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/ServiceImpl.html Gets the service's qualified name. ```APIDOC ## getName ### Description Gets the service's qualified name. ### Method public QName getName() ``` -------------------------------- ### Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/transform/OutTransformWriter.html Details on how to instantiate the OutTransformWriter class with various configurations. ```APIDOC ## Constructors ### OutTransformWriter(XMLStreamWriter writer, Map outMap) Creates a new OutTransformWriter with the specified XMLStreamWriter and output map. ### OutTransformWriter(XMLStreamWriter writer, Map outMap, Map append, List dropEls, boolean attributesToElements, String defaultNamespace) Creates a new OutTransformWriter with detailed configuration including append, drop, and attribute-to-element settings. ### OutTransformWriter(XMLStreamWriter writer, Map outEMap, Map append, List dropEls, Map outAMap, boolean attributesToElements, String defaultNamespace) Creates a new OutTransformWriter with comprehensive configuration including element and attribute maps, append, drop, and attribute-to-element settings. ``` -------------------------------- ### OutFaultChainInitiatorObserver Constructor Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/interceptor/OutFaultChainInitiatorObserver.html Constructs a new OutFaultChainInitiatorObserver with the given Bus. ```APIDOC ## OutFaultChainInitiatorObserver(Bus bus) ### Description Constructs a new OutFaultChainInitiatorObserver. ### Parameters * **bus** (Bus) - The Bus instance to be used. ``` -------------------------------- ### get Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/extension/RegistryImpl.html Returns the object stored under the given key. ```APIDOC ## get ### Description Returns the object stored under the given key. ### Method public T ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **k** (K) - Required - the key ### Request Example ```json { "k": "key" } ``` ### Response #### Success Response (T) - **T** (T) - the object stored under the key #### Response Example ```json { "example": "object" } ``` ``` -------------------------------- ### ClientLifeCycleManagerImpl Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/bus/managers/ClientLifeCycleManagerImpl.html Constructors for initializing ClientLifeCycleManagerImpl. ```APIDOC ## Constructor Summary Constructors Constructor Description `ClientLifeCycleManagerImpl()` `ClientLifeCycleManagerImpl(Bus b)` ``` -------------------------------- ### getSupportedWriterFormats Method Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/databinding/stax/StaxDataBinding.html Gets the supported writer formats. ```APIDOC ## getSupportedWriterFormats() ### Description Gets the supported writer formats. ### Method `public Class[] getSupportedWriterFormats()` ### Response #### Success Response (200) - **return value** (Class[]) - An array of supported writer format classes. ``` -------------------------------- ### getSupportedReaderFormats Method Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/databinding/stax/StaxDataBinding.html Gets the supported reader formats. ```APIDOC ## getSupportedReaderFormats() ### Description Gets the supported reader formats. ### Method `public Class[] getSupportedReaderFormats()` ### Response #### Success Response (200) - **return value** (Class[]) - An array of supported reader format classes. ``` -------------------------------- ### initialize(Server server, Bus bus) Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/feature/AbstractPortableFeature.html Initializes the feature for a given Server and Bus. This method is part of the Feature interface. ```APIDOC ## initialize(Server server, Bus bus) ### Description Initializes the feature for a given Server and Bus. This method is part of the Feature interface. ### Method Default Method ### Parameters * **server** (Server) - The Server instance to initialize. * **bus** (Bus) - The Bus instance associated with the server. ``` -------------------------------- ### isStartElement Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/staxutils/DepthXMLStreamReader.html Checks if the current event is a start element event. ```APIDOC ## isStartElement ### Description Checks if the current event is a start element event. ### Method public boolean isStartElement() ### Returns `true` if the current event is a start element event, `false` otherwise. ``` -------------------------------- ### SingletonFactory Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/invoker/SingletonFactory.html Provides documentation for the core methods of the SingletonFactory class: create and release. ```APIDOC ## SingletonFactory Methods ### create(Exchange ex) Creates the object that will be used for the invoke. * **Method:** public Object create(Exchange ex) throws Throwable * **Implements:** `Factory.create` * **Description:** This method is responsible for providing the single instance managed by the factory. It may return the same instance on subsequent calls. * **Throws:** `Throwable` if an error occurs during object creation. ### release(Exchange ex, Object o) Post invoke, this is called to allow the factory to release the object, store it, etc... * **Method:** public void release(Exchange ex, Object o) * **Implements:** `Factory.release` * **Description:** This method is called after an object has been used. For SingletonFactory, it typically does nothing as the instance is reused. * **Parameters:** * **ex** (Exchange) - The current exchange context. * **o** (Object) - The object that was created and used. ``` -------------------------------- ### getWSDLLocation Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Gets the WSDL location from the provided endpoint reference. ```APIDOC ## Method Details ### getWSDLLocation `public static String getWSDLLocation(org.apache.cxf.ws.addressing.EndpointReferenceType ref)` ``` -------------------------------- ### StringMapImpl Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/message/StringMapImpl.html Provides details on how to instantiate StringMapImpl objects. ```APIDOC ## Constructors ### StringMapImpl() Default constructor. ### StringMapImpl(int initialSize, float factor) Constructor with initial size and load factor. ### StringMapImpl(Map i) Constructor that initializes the map with the contents of another map. ``` -------------------------------- ### getInterfaceName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Gets the interface name of the provided endpoint reference. ```APIDOC ## Method Details ### getInterfaceName `public static QName getInterfaceName(org.apache.cxf.ws.addressing.EndpointReferenceType ref, Bus bus)` ``` -------------------------------- ### start Method Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/endpoint/ClientCallback.html Called when a message is first received prior to any actions being applied to the message. This method allows for modifications to the InterceptorChain. ```APIDOC ## start(Message msg) ### Description Called when a message is first received prior to any actions being applied to the message. The InterceptorChain is setup so modifications to that can be done. ### Method `public void start(Message msg)` ### Parameters * **msg** (Message) - The message received. ``` -------------------------------- ### getPortName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Gets the port name of the provided endpoint reference. ```APIDOC ## Method Details ### getPortName `public static String getPortName(org.apache.cxf.ws.addressing.EndpointReferenceType ref)` Gets the port name of the provided endpoint reference. Parameters: * `ref` - the endpoint reference. Returns: the port name. ``` -------------------------------- ### Constructor Details Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/phase/Phase.html Details for the constructors of the Phase class. ```APIDOC ## Constructor Details ### Phase() `public Phase()` ### Phase(String n, int p) `public Phase(String n, int p)` ``` -------------------------------- ### getServiceName Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/ws/addressing/EndpointReferenceUtils.html Gets the service name of the provided endpoint reference. ```APIDOC ## Method Details ### getServiceName `public static QName getServiceName(org.apache.cxf.ws.addressing.EndpointReferenceType ref, Bus bus)` Gets the service name of the provided endpoint reference. Parameters: * `ref` - the endpoint reference. Returns: the service name. ``` -------------------------------- ### SimpleGroup Constructors Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/common/security/SimpleGroup.html Provides details on the different ways to instantiate a SimpleGroup object. ```APIDOC ## Constructor Summary Constructors Constructor Description `SimpleGroup(String groupName)` `SimpleGroup(String groupName, String memberName)` `SimpleGroup(String groupName, Principal member)` ``` -------------------------------- ### Factory Interface Methods Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/service/invoker/Factory.html This snippet details the methods available in the Factory interface, including `create` and `release`. ```APIDOC ## Interface Factory Represents an object factory. Used at invoke time to find the object that the invokation will use. ### Methods #### `Object create(Exchange e)` Creates the object that will be used for the invoke. ##### Parameters * **e** (Exchange) - Description not specified. ##### Throws * **Throwable** #### `void release(Exchange e, Object o)` Post invoke, this is called to allow the factory to release the object, store it, etc... ##### Parameters * **e** (Exchange) - Description not specified. * **o** (Object) - object created from the create method. ``` -------------------------------- ### Get Name Source: https://cxf.apache.org/javadoc/latest-4.0.x/org/apache/cxf/version/Version.html Retrieves the name of the Apache CXF project. ```APIDOC ## getName ### Description Returns the name of the Apache CXF project. ### Method ```java public static String getName() ``` ```