org.wildfly.client.config.ConfigurationXMLStreamReader Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.client.config;
import static org.wildfly.client.config._private.ConfigMessages.msg;
import java.net.InetAddress;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import org.wildfly.common.expression.Expression;
import org.wildfly.common.net.CidrAddress;
import org.wildfly.common.net.Inet;
/**
* @author David M. Lloyd
*/
public interface ConfigurationXMLStreamReader extends XMLStreamReader, AutoCloseable {
char[] EMPTY_CHARS = new char[0];
URI getUri();
XMLInputFactory getXmlInputFactory();
XMLLocation getIncludedFrom();
boolean hasNext() throws ConfigXMLParseException;
int next() throws ConfigXMLParseException;
/**
* Determine whether the current element has a non-empty namespace URI.
*
* @return {@code true} if the element has a non-empty namespace URI, {@code false} otherwise
*/
default boolean hasNamespace() {
final String namespaceURI = getNamespaceURI();
return namespaceURI != null && ! namespaceURI.isEmpty();
}
/**
* Determine whether the current element has a namespace URI equal to the given value. If the given
* value is {@code null} or empty, this method returns {@code true} only if the current element has no namespace.
*
* @param uri the namespace URI to test
* @return {@code true} if the element has a namespace URI equal to the argument, or the argument is {@code null} or empty
* and the element has no namespace, or {@code false} otherwise
*/
default boolean namespaceURIEquals(String uri) {
return uri == null || uri.isEmpty() ? ! hasNamespace() : uri.equals(getNamespaceURI());
}
/**
* Determine whether the current element has an attribute at the given index with a non-empty namespace URI.
*
* @param idx the attribute index
* @return {@code true} if the attribute has a non-empty namespace URI, {@code false} otherwise
*/
default boolean hasAttributeNamespace(int idx) {
final String attributeNamespace = getAttributeNamespace(idx);
return attributeNamespace != null && ! attributeNamespace.isEmpty();
}
/**
* Determine whether the current element has an attribute at the given index with a namespace URI equal to the given value. If the given
* value is {@code null} or empty, this method returns {@code true} only if the attribute has no namespace.
*
* @param idx the attribute index
* @param uri the namespace URI to test
* @return {@code true} if the attribute has a namespace URI equal to the argument, or the argument is {@code null} or empty
* and the element has no namespace, or {@code false} otherwise
*/
default boolean attributeNamespaceEquals(int idx, String uri) {
return uri == null || uri.isEmpty() ? ! hasAttributeNamespace(idx) : uri.equals(getAttributeNamespace(idx));
}
default int nextTag() throws ConfigXMLParseException {
int eventType;
for (;;) {
eventType = next();
switch (eventType) {
case SPACE:
case PROCESSING_INSTRUCTION:
case COMMENT: {
break;
}
case START_ELEMENT:
case END_ELEMENT: {
return eventType;
}
case CHARACTERS:
case CDATA: {
if (isWhiteSpace()) {
break;
}
// fall thru
}
default: {
throw msg.expectedStartOrEndElement(eventToString(eventType), getLocation());
}
}
}
}
default String getElementText() throws ConfigXMLParseException {
int eventType = getEventType();
if (eventType != START_ELEMENT) {
throw msg.expectedStartElement(eventToString(eventType), getLocation());
}
final StringBuilder sb = new StringBuilder();
for (;;) {
eventType = next();
switch (eventType) {
case END_ELEMENT: {
return sb.toString();
}
case CHARACTERS:
case CDATA:
case SPACE:
case ENTITY_REFERENCE: {
sb.append(getText());
break;
}
case PROCESSING_INSTRUCTION:
case COMMENT: {
// skip
break;
}
case END_DOCUMENT: {
throw msg.unexpectedDocumentEnd(getLocation());
}
case START_ELEMENT: {
throw msg.textCannotContainElements(getLocation());
}
default: {
throw msg.unexpectedContent(eventToString(eventType), getLocation());
}
}
}
}
/**
* Get the element text content as an expression.
*
* @param flags the expression compilation flags
* @return the expression (not {@code null})
* @throws ConfigXMLParseException if the value is not a valid expression by the given flags
*/
default Expression getElementExpression(Expression.Flag... flags) throws ConfigXMLParseException {
try {
return Expression.compile(getElementText(), flags);
} catch (IllegalArgumentException ex) {
throw msg.expressionTextParseException(ex, getLocation());
}
}
default void require(final int type, final String namespaceURI, final String localName) throws ConfigXMLParseException {
if (getEventType() != type) {
throw msg.expectedEventType(eventToString(type), eventToString(getEventType()), getLocation());
} else if (namespaceURI != null && !namespaceURI.equals(getNamespaceURI())) {
throw msg.expectedNamespace(namespaceURI, getNamespaceURI(), getLocation());
} else if (localName != null && !localName.equals(getLocalName())) {
throw msg.expectedLocalName(localName, getLocalName(), getLocation());
}
}
default boolean isStartElement() {
return getEventType() == START_ELEMENT;
}
default boolean isEndElement() {
return getEventType() == END_ELEMENT;
}
default boolean isCharacters() {
return getEventType() == CHARACTERS;
}
default boolean isWhiteSpace() {
return getEventType() == SPACE || getEventType() == CHARACTERS && getText().trim().isEmpty();
}
static String eventToString(final int type) {
switch (type) {
case START_DOCUMENT: return "document start";
case END_DOCUMENT: return "document end";
case START_ELEMENT: return "start element";
case END_ELEMENT: return "end element";
case CDATA: return "cdata";
case CHARACTERS: return "characters";
case ATTRIBUTE: return "attribute";
case DTD: return "dtd";
case ENTITY_DECLARATION: return "entity declaration";
case ENTITY_REFERENCE: return "entity reference";
case NAMESPACE: return "namespace";
case NOTATION_DECLARATION: return "notation declaration";
case PROCESSING_INSTRUCTION: return "processing instruction";
case SPACE: return "white space";
default: return "unknown";
}
}
default Object getProperty(final String name) throws IllegalArgumentException {
return null;
}
default boolean hasText() {
switch (getEventType()) {
case CHARACTERS:
case DTD:
case ENTITY_REFERENCE:
case COMMENT:
case SPACE: {
return true;
}
default: {
return false;
}
}
}
default boolean isStandalone() {
return false;
}
default boolean standaloneSet() {
return false;
}
default boolean hasName() {
final int eventType = getEventType();
return eventType == START_ELEMENT || eventType == END_ELEMENT;
}
XMLLocation getLocation();
int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws ConfigXMLParseException;
void close() throws ConfigXMLParseException;
default void skipContent() throws ConfigXMLParseException {
while (hasNext()) {
switch (next()) {
case START_ELEMENT: {
skipContent();
break;
}
case END_ELEMENT: {
return;
}
}
}
}
// ===== exceptions =====
/**
* Return a throwable exception explaining that the element at the current position was not expected.
*
* @return the exception
*/
default ConfigXMLParseException unexpectedElement() {
final String namespaceURI = getNamespaceURI();
final String localName = getLocalName();
if (namespaceURI == null) {
return msg.unexpectedElement(localName, getLocation());
} else {
return msg.unexpectedElement(localName, namespaceURI, getLocation());
}
}
/**
* Return a throwable exception explaining that the attribute at the current position with the given index was not
* expected.
*
* @param i the attribute index
* @return the exception
*/
default ConfigXMLParseException unexpectedAttribute(int i) {
return msg.unexpectedAttribute(getAttributeName(i), getLocation());
}
/**
* Return a throwable exception explaining that the document end was reached unexpectedly.
*
* @return the exception
*/
default ConfigXMLParseException unexpectedDocumentEnd() {
return msg.unexpectedDocumentEnd(getLocation());
}
/**
* Return a throwable exception explaining that some unexpected content was encountered.
*
* @return the exception
*/
default ConfigXMLParseException unexpectedContent() {
return msg.unexpectedContent(eventToString(getEventType()), getLocation());
}
/**
* Return a throwable exception explaining that a required element with the given namespace and local name was missing.
*
* @param namespaceUri the namespace URI
* @param localName the local element name
* @return the exception
*/
default ConfigXMLParseException missingRequiredElement(String namespaceUri, String localName) {
return msg.missingRequiredElement(namespaceUri, localName, getLocation());
}
/**
* Return a throwable exception explaining that a required attribute with the given namespace and local name was missing.
*
* @param namespaceUri the namespace URI (or {@code null} if it is a local name)
* @param localName the local attribute name
* @return the exception
*/
default ConfigXMLParseException missingRequiredAttribute(String namespaceUri, String localName) {
return msg.missingRequiredAttribute(namespaceUri, localName, getLocation());
}
/**
* Return a throwable exception explaining that a numeric attribute at the given index was out of its required range.
*
* @param index the attribute index
* @param minValue the minimum attribute value
* @param maxValue the maximum attribute value
* @return the exception
*/
default ConfigXMLParseException numericAttributeValueOutOfRange(int index, long minValue, long maxValue) {
return msg.numericAttributeValueOutOfRange(getAttributeName(index), getAttributeValue(index), minValue, maxValue, getLocation());
}
// ===== attribute helpers =====
/**
* Get the value of an attribute.
*
* @param index the index of the attribute
* @return the attribute value
*/
String getAttributeValue(int index);
/**
* Get the value of an attribute with expressions resolved.
*
* @param index the index of the attribute
* @return the attribute value
* @throws ConfigXMLParseException if an error occurs
*/
default String getAttributeValueResolved(int index) throws ConfigXMLParseException {
final Expression expression = getExpressionAttributeValue(index, Expression.Flag.ESCAPES);
return expression.evaluateWithPropertiesAndEnvironment(false);
}
/**
* Get the value of an attribute as an integer.
*
* @param index the index of the attribute
*
* @return the integer value
*
* @throws ConfigXMLParseException if an error occurs
*/
default int getIntAttributeValue(int index) throws ConfigXMLParseException {
try {
return Integer.parseInt(getAttributeValue(index));
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as an integer with expressions resolved.
*
* @param index the index of the attribute
*
* @return the integer value
*
* @throws ConfigXMLParseException if an error occurs
*/
default int getIntAttributeValueResolved(int index) throws ConfigXMLParseException {
try {
return Integer.parseInt(getAttributeValueResolved(index));
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as an integer.
*
* @param index the index of the attribute
* @param minValue the minimum allowed value
* @param maxValue the maximum allowed value
*
* @return the integer value
*
* @throws ConfigXMLParseException if an error occurs
*/
default int getIntAttributeValue(int index, int minValue, int maxValue) throws ConfigXMLParseException {
final int value = getIntAttributeValue(index);
if (value < minValue || value > maxValue) {
throw numericAttributeValueOutOfRange(index, minValue, maxValue);
}
return value;
}
/**
* Get the value of an attribute as an integer with expressions resolved.
*
* @param index the index of the attribute
* @param minValue the minimum allowed value
* @param maxValue the maximum allowed value
*
* @return the integer value
*
* @throws ConfigXMLParseException if an error occurs
*/
default int getIntAttributeValueResolved(int index, int minValue, int maxValue) throws ConfigXMLParseException {
final int value = getIntAttributeValueResolved(index);
if (value < minValue || value > maxValue) {
throw numericAttributeValueOutOfRange(index, minValue, maxValue);
}
return value;
}
/**
* Get the value of an attribute as an integer list.
*
* @param index the index of the attribute
*
* @return the integer values
*
* @throws ConfigXMLParseException if an error occurs
*/
default int[] getIntListAttributeValue(int index) throws ConfigXMLParseException {
try {
return new Delimiterator(getAttributeValue(index), ' ').toIntArray();
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as an integer list with expressions resolved.
*
* @param index the index of the attribute
*
* @return the integer values
*
* @throws ConfigXMLParseException if an error occurs
*/
default int[] getIntListAttributeValueResolved(int index) throws ConfigXMLParseException {
try {
return new Delimiterator(getAttributeValueResolved(index), ' ').toIntArray();
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as a space-delimited string list, as an iterator.
*
* @param index the index of the attribute
* @return the values
* @throws ConfigXMLParseException if an error occurs
*/
default Iterator getListAttributeValueAsIterator(int index) throws ConfigXMLParseException {
return new Delimiterator(getAttributeValue(index), ' ');
}
/**
/**
* Get the value of an attribute as a space-delimited string list with expressions resolved, as an iterator.
*
* @param index the index of the attribute
* @return the values
* @throws ConfigXMLParseException if an error occurs
*/
default Iterator getListAttributeValueAsIteratorResolved(int index) throws ConfigXMLParseException {
return new Delimiterator(getAttributeValueResolved(index), ' ');
}
/**
* Get the value of an attribute as a space-delimited string list.
*
* @param index the index of the attribute
* @return the values
* @throws ConfigXMLParseException if an error occurs
*/
default List getListAttributeValue(int index) throws ConfigXMLParseException {
return Arrays.asList(getListAttributeValueAsArray(index));
}
/**
* Get the value of an attribute as a space-delimited string list with expressions resolved.
*
* @param index the index of the attribute
* @return the values
* @throws ConfigXMLParseException if an error occurs
*/
default List getListAttributeValueResolved(int index) throws ConfigXMLParseException {
return Arrays.asList(getListAttributeValueAsArrayResolved(index));
}
/**
* Get the value of an attribute as a space-delimited string list, as an array.
*
* @param index the index of the attribute
*
* @return the values
*
* @throws ConfigXMLParseException if an error occurs
*/
default String[] getListAttributeValueAsArray(int index) throws ConfigXMLParseException {
return new Delimiterator(getAttributeValue(index), ' ').toStringArray();
}
/**
* Get the value of an attribute as a space-delimited string list with expressions resolved, as an array.
*
* @param index the index of the attribute
*
* @return the values
*
* @throws ConfigXMLParseException if an error occurs
*/
default String[] getListAttributeValueAsArrayResolved(int index) throws ConfigXMLParseException {
return new Delimiterator(getAttributeValueResolved(index), ' ').toStringArray();
}
/**
* Get the value of an attribute as a long.
*
* @param index the index of the attribute
*
* @return the long value
*
* @throws ConfigXMLParseException if an error occurs
*/
default long getLongAttributeValue(int index) throws ConfigXMLParseException {
try {
return Long.parseLong(getAttributeValue(index));
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as a long with expressions resolved.
*
* @param index the index of the attribute
*
* @return the long value
*
* @throws ConfigXMLParseException if an error occurs
*/
default long getLongAttributeValueResolved(int index) throws ConfigXMLParseException {
try {
return Long.parseLong(getAttributeValueResolved(index));
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as a long.
*
* @param index the index of the attribute
* @param minValue the minimum allowed value
* @param maxValue the maximum allowed value
*
* @return the long value
*
* @throws ConfigXMLParseException if an error occurs
*/
default long getLongAttributeValue(int index, long minValue, long maxValue) throws ConfigXMLParseException {
final long value = getLongAttributeValue(index);
if (value < minValue || value > maxValue) {
throw numericAttributeValueOutOfRange(index, minValue, maxValue);
}
return value;
}
/**
* Get the value of an attribute as a long with expressions resolved.
*
* @param index the index of the attribute
* @param minValue the minimum allowed value
* @param maxValue the maximum allowed value
*
* @return the long value
*
* @throws ConfigXMLParseException if an error occurs
*/
default long getLongAttributeValueResolved(int index, long minValue, long maxValue) throws ConfigXMLParseException {
final long value = getLongAttributeValueResolved(index);
if (value < minValue || value > maxValue) {
throw numericAttributeValueOutOfRange(index, minValue, maxValue);
}
return value;
}
/**
* Get the value of an attribute as a long integer list.
*
* @param index the index of the attribute
*
* @return the long values
*
* @throws ConfigXMLParseException if an error occurs
*/
default long[] getLongListAttributeValue(int index) throws ConfigXMLParseException {
try {
return new Delimiterator(getAttributeValue(index), ' ').toLongArray();
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get the value of an attribute as a long integer list with expressions resolved.
*
* @param index the index of the attribute
*
* @return the long values
*
* @throws ConfigXMLParseException if an error occurs
*/
default long[] getLongListAttributeValueResolved(int index) throws ConfigXMLParseException {
try {
return new Delimiterator(getAttributeValueResolved(index), ' ').toLongArray();
} catch (NumberFormatException e) {
throw msg.intParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get an attribute value as a {@code boolean}. Only the string {@code "true"} (case-insensitive) is recognized as
* a {@code true} value; all other strings are considered {@code false}.
*
* @param index the attribute index
* @return the attribute value
*/
default boolean getBooleanAttributeValue(int index) {
return Boolean.parseBoolean(getAttributeValue(index));
}
/**
* Get an attribute value as a {@code boolean} with expressions resolved. Only the string {@code "true"} (case-insensitive) is recognized as
* a {@code true} value; all other strings are considered {@code false}.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if an error occurs
*/
default boolean getBooleanAttributeValueResolved(int index) throws ConfigXMLParseException {
return Boolean.parseBoolean(getAttributeValueResolved(index));
}
/**
* Get an attribute value as a {@link URI}.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid URI
*/
default URI getURIAttributeValue(int index) throws ConfigXMLParseException {
try {
return new URI(getAttributeValue(index));
} catch (URISyntaxException e) {
throw msg.uriParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get an attribute value as a {@link URI} with expressions resolved.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid URI
*/
default URI getURIAttributeValueResolved(int index) throws ConfigXMLParseException {
try {
return new URI(getAttributeValueResolved(index));
} catch (URISyntaxException e) {
throw msg.uriParseException(e, getAttributeName(index), getLocation());
}
}
/**
* Get an attribute value as a compiled {@link Expression}.
*
* @param index the attribute index
* @param flags the expression compilation flags
* @return the expression, or {@code null} if the attribute is not present
* @throws ConfigXMLParseException if the value is not a valid expression by the given flags
*/
default Expression getExpressionAttributeValue(int index, Expression.Flag... flags) throws ConfigXMLParseException {
final String attributeValue = getAttributeValue(index);
if (attributeValue == null) {
return null;
} else try {
return Expression.compile(attributeValue, flags);
} catch (IllegalArgumentException ex) {
throw msg.expressionParseException(ex, getAttributeName(index), getLocation());
}
}
/**
* Get an attribute value as a {@link InetAddress}.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid IP address
*/
default InetAddress getInetAddressAttributeValue(int index) throws ConfigXMLParseException {
final String attributeValue = getAttributeValue(index);
if (attributeValue == null) {
return null;
} else {
final InetAddress inetAddress = Inet.parseInetAddress(attributeValue);
if (inetAddress == null) {
throw msg.inetAddressParseException(getAttributeName(index), attributeValue, getLocation());
}
return inetAddress;
}
}
/**
* Get an attribute value as a {@link InetAddress} with expressions resolved.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid IP address
*/
default InetAddress getInetAddressAttributeValueResolved(int index) throws ConfigXMLParseException {
final String attributeValue = getAttributeValueResolved(index);
if (attributeValue == null) {
return null;
} else {
final InetAddress inetAddress = Inet.parseInetAddress(attributeValue);
if (inetAddress == null) {
throw msg.inetAddressParseException(getAttributeName(index), attributeValue, getLocation());
}
return inetAddress;
}
}
/**
* Get an attribute value as a {@link CidrAddress}.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid IP address
*/
default CidrAddress getCidrAddressAttributeValue(int index) throws ConfigXMLParseException {
final String attributeValue = getAttributeValue(index);
if (attributeValue == null) {
return null;
} else {
final CidrAddress cidrAddress = Inet.parseCidrAddress(attributeValue);
if (cidrAddress == null) {
throw msg.cidrAddressParseException(getAttributeName(index), attributeValue, getLocation());
}
return cidrAddress;
}
}
/**
* Get an attribute value as a {@link CidrAddress} with expressions resolved.
*
* @param index the attribute index
* @return the attribute value
* @throws ConfigXMLParseException if the value is not a valid IP address
*/
default CidrAddress getCidrAddressAttributeValueResolved(int index) throws ConfigXMLParseException {
final String attributeValue = getAttributeValueResolved(index);
if (attributeValue == null) {
return null;
} else {
final CidrAddress cidrAddress = Inet.parseCidrAddress(attributeValue);
if (cidrAddress == null) {
throw msg.cidrAddressParseException(getAttributeName(index), attributeValue, getLocation());
}
return cidrAddress;
}
}
}