/*
* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.xml.catalog;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Objects;
/**
* Represents a general Catalog entry.
*
* @since 9
*/
abstract class BaseEntry {
final String SLASH = "/";
CatalogEntryType type;
//The id attribute
String id;
//The attribute to be matched, e.g. systemId
String matchId;
//The baseURI attribute
URL baseURI;
//Indicates whether the base attribute is specified
boolean baseSpecified = false;
/**
* CatalogEntryType represents catalog entry types.
*/
static enum CatalogEntryType {
CATALOG("catalogfile"),
CATALOGENTRY("catalog"),
GROUP("group"),
PUBLIC("public"),
SYSTEM("system"),
REWRITESYSTEM("rewriteSystem"),
SYSTEMSUFFIX("systemSuffix"),
DELEGATEPUBLIC("delegatePublic"),
DELEGATESYSTEM("delegateSystem"),
URI("uri"),
REWRITEURI("rewriteURI"),
URISUFFIX("uriSuffix"),
DELEGATEURI("delegateURI"),
NEXTCATALOG("nextCatalog");
final String literal;
CatalogEntryType(String literal) {
this.literal = literal;
}
public boolean isType(String type) {
return literal.equals(type);
}
static public CatalogEntryType getType(String entryType) {
for (CatalogEntryType type : CatalogEntryType.values()) {
if (type.isType(entryType)) {
return type;
}
}
return null;
}
}
/**
* Constructs a CatalogEntry
*
* @param type The type of the entry
*/
public BaseEntry(CatalogEntryType type) {
this.type = Objects.requireNonNull(type);
}
/**
* Constructs a CatalogEntry
*
* @param type The type of the entry
* @param base The base URI
*/
public BaseEntry(CatalogEntryType type, String base) {
this.type = Objects.requireNonNull(type);
setBaseURI(base);
}
/**
* Returns the type of the entry
*
* @return The type of the entry
*/
public CatalogEntryType getType() {
return type;
}
/**
* Sets the entry type
*
* @param type The entry type
*/
public void setType(CatalogEntryType type) {
this.type = type;
}
/**
* Returns the id of the entry
*
* @return The id of the entry
*/
public String getId() {
return id;
}
/**
* Set the entry Id
*
* @param id The Id attribute
*/
public void setId(String id) {
this.id = id;
}
/**
* Sets the base URI for the entry
*
* @param base The base URI
*/
public final void setBaseURI(String base) {
baseURI = verifyURI("base", null, base);
}
/**
* Gets the base URI for the entry
*
* @return The base URI as a string.
*/
public URL getBaseURI() {
return baseURI;
}
/**
* Gets the attribute used for matching
*
* @return The value of the field
*/
public String getMatchId() {
return matchId;
}
/**
* Sets the matchId field
* @param matchId The value of the Id
*/
public void setMatchId(String matchId) {
this.matchId = matchId;
}
/**
* Matches the specified string with the identifier attribute of the entry.
*
* @param match The identifier attribute to be matched
* @return The replacement URI if a matching entry is found, null if not.
*/
public String match(String match) {
return null;
}
/**
* Try to match the specified id with the entry. Return the match if it
* is successful and the length of the start String is longer than the
* longest of any previous match.
*
* @param id The id to be matched.
* @param currentMatch The length of start String of previous match if any.
* @return The replacement URI if the match is successful, null if not.
*/
public String match(String id, int currentMatch) {
return null;
}
/**
* Verifies the specified URI.
*
* @param arg The name of the argument
* @param uri The URI to be verified
* @return The URI created from the specified uri
* @throws IllegalArgumentException if the specified uri is null,
* or an URL can not be created based on the specified base and uri
*/
URL verifyURI(String arg, URL base, String uri) {
if (uri == null) {
CatalogMessages.reportIAE(new Object[]{uri, arg}, null);
}
URL url = null;
uri = Normalizer.normalizeURI(uri);
try {
if (base != null) {
url = new URL(base, uri);
} else {
url = new URL(uri);
}
} catch (MalformedURLException e) {
CatalogMessages.reportIAE(new Object[]{uri, arg}, e);
}
return url;
}
/**
* Construct an absolute URI from a relative one, using the current base
* URI.
*
* @param sysid The (possibly relative) system identifier
* @return The system identifier made absolute with respect to the current
* {@link #base}.
*/
protected String makeAbsolute(String sysid) {
URL local = null;
sysid = Util.fixSlashes(sysid);
/**
* try { local = new URL(base, sysid); } catch (MalformedURLException e)
* { catalogManager.debug.message(1, "Malformed URL on system
* identifier", sysid); }
*/
if (local != null) {
return local.toString();
} else {
return sysid;
}
}
}