com.unboundid.util.args.URLArgumentValueValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2015-2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2015-2023 Ping Identity Corporation
*
* 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.
*/
/*
* Copyright (C) 2015-2023 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.util.args;
import java.io.Serializable;
import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.util.args.ArgsMessages.*;
/**
* This class provides an implementation of an argument value validator that is
* expected to be used with a string argument and ensures that all values for
* the argument are valid URLs. It can optionally restrict the URLs to a
* specified set of schemes.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class URLArgumentValueValidator
extends ArgumentValueValidator
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -4431100566624433212L;
// The set of schemes allowed to be used in URLs.
@NotNull private final Set allowedSchemes;
/**
* Creates a new instance of this URL argument value validator that will
* accept values that are URLs with any of the specified schemes.
*
* @param allowedSchemes The names of the schemes for the URLs that will be
* accepted. It may be {@code null} or empty if any
* scheme will be accepted.
*/
public URLArgumentValueValidator(@Nullable final String... allowedSchemes)
{
this(StaticUtils.toList(allowedSchemes));
}
/**
* Creates a new instance of this URL argument value validator that will
* accept values that are URLs with any of the specified schemes.
*
* @param allowedSchemes The names of the schemes for the URLs that will be
* accepted. It may be {@code null} or empty if any
* scheme will be accepted.
*/
public URLArgumentValueValidator(
@Nullable final Collection allowedSchemes)
{
if (allowedSchemes == null)
{
this.allowedSchemes = Collections.emptySet();
}
else
{
this.allowedSchemes =
Collections.unmodifiableSet(new LinkedHashSet<>(allowedSchemes));
}
}
/**
* Retrieves the names of the schemes for the URLs that will be accepted.
*
* @return The names of the schemes for the URLs that will be accepted, or
* an empty set if URLs will be allowed to have any scheme.
*/
@NotNull()
public Set getAllowedSchemes()
{
return allowedSchemes;
}
/**
* {@inheritDoc}
*/
@Override()
public void validateArgumentValue(@NotNull final Argument argument,
@NotNull final String valueString)
throws ArgumentException
{
final URI uri;
try
{
uri = new URI(valueString);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new ArgumentException(
ERR_URL_VALIDATOR_VALUE_NOT_URL.get(valueString,
argument.getIdentifierString(),
StaticUtils.getExceptionMessage(e)),
e);
}
if (uri.getScheme() == null)
{
throw new ArgumentException(ERR_URL_VALIDATOR_MISSING_SCHEME.get(
valueString, argument.getIdentifierString()));
}
if ((! allowedSchemes.isEmpty()) &&
(! allowedSchemes.contains(uri.getScheme())))
{
throw new ArgumentException(
ERR_URL_VALIDATOR_UNACCEPTABLE_SCHEME.get(valueString,
argument.getIdentifierString(), uri.getScheme()));
}
}
/**
* Retrieves a string representation of this argument value validator.
*
* @return A string representation of this argument value validator.
*/
@Override()
@NotNull()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* Appends a string representation of this argument value validator to the
* provided buffer.
*
* @param buffer The buffer to which the string representation should be
* appended.
*/
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("URLArgumentValueValidator(");
buffer.append("allowedSchemes={");
final Iterator iterator = allowedSchemes.iterator();
while (iterator.hasNext())
{
buffer.append('\'');
buffer.append(iterator.next());
buffer.append('\'');
if (iterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("})");
}
}