/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014-2015 ForgeRock AS
|
*/
|
|
package org.opends.server.admin;
|
|
|
|
import static org.forgerock.util.Reject.ifNull;
|
|
import java.net.InetAddress;
|
import java.net.UnknownHostException;
|
import java.util.EnumSet;
|
|
|
|
/**
|
* IP address property definition.
|
*/
|
public final class IPAddressPropertyDefinition extends
|
PropertyDefinition<InetAddress> {
|
|
/**
|
* An interface for incrementally constructing IP address property
|
* definitions.
|
*/
|
public static class Builder extends
|
AbstractBuilder<InetAddress, IPAddressPropertyDefinition> {
|
|
/** Private constructor. */
|
private Builder(
|
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
|
super(d, propertyName);
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
protected IPAddressPropertyDefinition buildInstance(
|
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
|
EnumSet<PropertyOption> options,
|
AdministratorAction adminAction,
|
DefaultBehaviorProvider<InetAddress> defaultBehavior) {
|
return new IPAddressPropertyDefinition(d, propertyName, options,
|
adminAction, defaultBehavior);
|
}
|
|
}
|
|
|
|
/**
|
* Create a IP address property definition builder.
|
*
|
* @param d
|
* The managed object definition associated with this
|
* property definition.
|
* @param propertyName
|
* The property name.
|
* @return Returns the new IP address property definition builder.
|
*/
|
public static Builder createBuilder(
|
AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
|
return new Builder(d, propertyName);
|
}
|
|
|
|
/** Private constructor. */
|
private IPAddressPropertyDefinition(
|
AbstractManagedObjectDefinition<?, ?> d, String propertyName,
|
EnumSet<PropertyOption> options,
|
AdministratorAction adminAction,
|
DefaultBehaviorProvider<InetAddress> defaultBehavior) {
|
super(d, InetAddress.class, propertyName, options, adminAction,
|
defaultBehavior);
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public void validateValue(InetAddress value)
|
throws PropertyException {
|
ifNull(value);
|
|
// No additional validation required.
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public InetAddress decodeValue(String value)
|
throws PropertyException {
|
ifNull(value);
|
|
try {
|
return InetAddress.getByName(value);
|
} catch (UnknownHostException e) {
|
// TODO: it would be nice to throw the cause.
|
throw PropertyException.illegalPropertyValueException(this, value);
|
}
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public String encodeValue(InetAddress value)
|
throws PropertyException {
|
// We should return the host name if it is available, or the IP
|
// address if not.
|
|
// Unforunately, there is no InetAddress method for doing this, so
|
// we have to resort to hacking at the toString() encoding.
|
String s = value.toString();
|
int i = s.indexOf('/');
|
if (i > 0) {
|
// Host address is before the forward slash.
|
return s.substring(0, i);
|
} else {
|
return value.getHostAddress();
|
}
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
|
return v.visitIPAddress(this, p);
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public <R, P> R accept(PropertyValueVisitor<R, P> v, InetAddress value, P p) {
|
return v.visitIPAddress(this, value, p);
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public int compare(InetAddress o1, InetAddress o2) {
|
return o1.getHostAddress().compareTo(o2.getHostAddress());
|
}
|
}
|
