com.helger.xml.schema.SchemaCache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-xml Show documentation
Show all versions of ph-xml Show documentation
Java 1.8+ Library with XML handling routines
/*
* Copyright (C) 2014-2023 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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 com.helger.xml.schema;
import java.util.Collection;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import javax.xml.transform.Source;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.cache.Cache;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.io.resource.IReadableResource;
import com.helger.commons.state.EChange;
import com.helger.commons.string.ToStringGenerator;
import com.helger.xml.transform.TransformSourceFactory;
/**
* Base class for caching abstract {@link Schema} objects. A {@link Schema} is
* immutable and can therefore safely be used in multi-threaded environments.
*
* @author Philip Helger
*/
@ThreadSafe
public class SchemaCache extends Cache , Schema>
{
private final String m_sSchemaTypeName;
private final SchemaFactory m_aSchemaFactory;
public SchemaCache (@Nonnull final String sSchemaTypeName,
@Nonnull final SchemaFactory aSchemaFactory,
@Nullable final ErrorHandler aErrorHandler,
@Nullable final LSResourceResolver aResourceResolver)
{
super (aKey -> createSchema (aSchemaFactory, sSchemaTypeName, aKey), 500, SchemaCache.class.getName () + "$" + sSchemaTypeName);
ValueEnforcer.notNull (sSchemaTypeName, "SchemaTypeName");
ValueEnforcer.notNull (aSchemaFactory, "SchemaFactory");
m_sSchemaTypeName = sSchemaTypeName;
m_aSchemaFactory = aSchemaFactory;
m_aSchemaFactory.setErrorHandler (aErrorHandler);
m_aSchemaFactory.setResourceResolver (aResourceResolver);
}
@Nonnull
public final String getSchemaTypeName ()
{
return m_sSchemaTypeName;
}
@Nonnull
public final SchemaFactory getSchemaFactory ()
{
return m_aSchemaFactory;
}
@Nullable
public ErrorHandler getErrorHandler ()
{
return m_aSchemaFactory.getErrorHandler ();
}
@Nullable
public LSResourceResolver getResourceResolver ()
{
return m_aSchemaFactory.getResourceResolver ();
}
@Nonnull
public static Schema createSchema (@Nonnull final SchemaFactory aSchemaFactory,
@Nonnull final String sSchemaTypeName,
@Nonnull @Nonempty final ICommonsList aResources)
{
ValueEnforcer.notNull (aSchemaFactory, "SchemaFactory");
ValueEnforcer.notEmptyNoNullValue (aResources, "Resources");
// Collect all sources
final Source [] aSources = new Source [aResources.size ()];
for (int i = 0; i < aResources.size (); ++i)
aSources[i] = TransformSourceFactory.create (aResources.get (i));
try
{
final Schema ret = aSchemaFactory.newSchema (aSources);
if (ret == null)
throw new IllegalStateException ("Failed to create " + sSchemaTypeName + " schema from " + aResources.toString ());
return ret;
}
catch (final SAXException ex)
{
throw new IllegalArgumentException ("Failed to parse " + sSchemaTypeName + " from " + aResources.toString (), ex);
}
}
/**
* Get a cached {@link Schema} from a single resource.
*
* @param aResource
* The resource to parse into a {@link Schema}. May not be
* null.
* @return Either the {@link Schema} from the cache or the newly compiled one.
*/
@Nonnull
public final Schema getSchema (@Nonnull final IReadableResource aResource)
{
ValueEnforcer.notNull (aResource, "Resource");
return getFromCache (new CommonsArrayList <> (aResource));
}
/**
* Get a cached {@link Schema} that consists of multiple resources.
*
* @param aResources
* The resources to parse into a single {@link Schema}. May neither
* null nor empty nor may it contain null
* elements.
* @return Either the {@link Schema} from the cache or the newly compiled one.
*/
@Nonnull
public final Schema getSchema (@Nonnull @Nonempty final IReadableResource... aResources)
{
ValueEnforcer.notEmptyNoNullValue (aResources, "Resources");
// Copy the values into a new list to avoid external modification
return getFromCache (new CommonsArrayList <> (aResources));
}
/**
* Get a cached {@link Schema} that consists of multiple resources.
*
* @param aResources
* The resources to parse into a single {@link Schema}. May neither
* null nor empty nor may it contain null
* elements.
* @return Either the {@link Schema} from the cache or the newly compiled one.
*/
@Nonnull
public final Schema getSchema (@Nonnull @Nonempty final Collection aResources)
{
ValueEnforcer.notEmptyNoNullValue (aResources, "Resources");
// Copy the values into a new list to avoid external modification
return getFromCache (new CommonsArrayList <> (aResources));
}
/**
* Utility method to get the validator for a given schema using the error
* handler provided in the constructor.
*
* @param aSchema
* The schema for which the validator is to be retrieved. May not be
* null.
* @return The validator and never null.
*/
@Nonnull
public final Validator getValidatorFromSchema (@Nonnull final Schema aSchema)
{
ValueEnforcer.notNull (aSchema, "Schema");
final Validator aValidator = aSchema.newValidator ();
aValidator.setErrorHandler (m_aSchemaFactory.getErrorHandler ());
return aValidator;
}
/**
* Get a new validator based on the {@link Schema} that consists of a single
* resource.
*
* @param aResource
* The resource to parse into a single {@link Schema}. May not be
* null.
* @return A new {@link Validator} object. Never null.
* @see #getSchema(IReadableResource)
*/
@Nonnull
public final Validator getValidator (@Nonnull final IReadableResource aResource)
{
return getValidatorFromSchema (getSchema (aResource));
}
/**
* Get a new validator based on the {@link Schema} that consists of multiple
* resources.
*
* @param aResources
* The resources to parse into a single {@link Schema}. May neither
* null nor empty nor may it contain null
* elements.
* @return A new {@link Validator} object. Never null.
* @see #getSchema(IReadableResource...)
*/
@Nonnull
public final Validator getValidator (@Nonnull @Nonempty final IReadableResource... aResources)
{
return getValidatorFromSchema (getSchema (aResources));
}
/**
* Get a new validator based on the {@link Schema} that consists of multiple
* resources.
*
* @param aResources
* The resources to parse into a single {@link Schema}. May neither
* null nor empty nor may it contain null
* elements.
* @return A new {@link Validator} object. Never null.
* @see #getSchema(Collection)
*/
@Nonnull
public final Validator getValidator (@Nonnull @Nonempty final Collection aResources)
{
return getValidatorFromSchema (getSchema (aResources));
}
/**
* Utility method to remove a single resource from the schema cache.
*
* @param aKey
* The resource to remove. May not be null.
* @return {@link EChange}.
*/
@Nonnull
public EChange removeFromCache (@Nonnull final IReadableResource aKey)
{
return removeFromCache (new CommonsArrayList <> (aKey));
}
@Override
public String toString ()
{
return ToStringGenerator.getDerived (super.toString ()).append ("schemaTypeName", m_sSchemaTypeName).getToString ();
}
}