/*
|
* 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 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2012 ForgeRock AS
|
*
|
*/
|
package org.opends.server.schema;
|
|
|
|
import java.util.List;
|
|
import org.opends.server.admin.server.ConfigurationChangeListener;
|
import org.opends.server.admin.std.server.JPEGAttributeSyntaxCfg;
|
import org.opends.server.api.ApproximateMatchingRule;
|
import org.opends.server.api.AttributeSyntax;
|
import org.opends.server.api.EqualityMatchingRule;
|
import org.opends.server.api.OrderingMatchingRule;
|
import org.opends.server.api.SubstringMatchingRule;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.types.ByteSequence;
|
import org.opends.server.types.ConfigChangeResult;
|
import org.opends.server.types.ResultCode;
|
|
|
import static org.opends.server.loggers.ErrorLogger.*;
|
import static org.opends.messages.SchemaMessages.*;
|
|
import org.opends.messages.Message;
|
import org.opends.messages.MessageBuilder;
|
import static org.opends.server.schema.SchemaConstants.*;
|
|
|
/**
|
* This class implements the JPEG attribute syntax. This is actually
|
* two specifications - JPEG and JFIF. As an extension we allow JPEG
|
* and Exif, which is what most digital cameras use. We only check for
|
* valid JFIF and Exif headers.
|
*/
|
public class JPEGSyntax
|
extends AttributeSyntax<JPEGAttributeSyntaxCfg>
|
implements ConfigurationChangeListener<JPEGAttributeSyntaxCfg>
|
{
|
// The default equality matching rule for this syntax.
|
private EqualityMatchingRule defaultEqualityMatchingRule;
|
|
// The default ordering matching rule for this syntax.
|
private OrderingMatchingRule defaultOrderingMatchingRule;
|
|
// The default substring matching rule for this syntax.
|
private SubstringMatchingRule defaultSubstringMatchingRule;
|
|
// The current configuration for this JPEG syntax.
|
private volatile JPEGAttributeSyntaxCfg config;
|
|
|
|
/**
|
* Creates a new instance of this syntax. Note that the only thing that
|
* should be done here is to invoke the default constructor for the
|
* superclass. All initialization should be performed in the
|
* <CODE>initializeSyntax</CODE> method.
|
*/
|
public JPEGSyntax()
|
{
|
super();
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void initializeSyntax(JPEGAttributeSyntaxCfg configuration)
|
throws ConfigException
|
{
|
defaultEqualityMatchingRule =
|
DirectoryServer.getEqualityMatchingRule(EMR_OCTET_STRING_OID);
|
if (defaultEqualityMatchingRule == null)
|
{
|
logError(ERR_ATTR_SYNTAX_UNKNOWN_EQUALITY_MATCHING_RULE.get(
|
EMR_OCTET_STRING_OID, SYNTAX_JPEG_NAME));
|
}
|
|
defaultOrderingMatchingRule =
|
DirectoryServer.getOrderingMatchingRule(OMR_OCTET_STRING_OID);
|
if (defaultOrderingMatchingRule == null)
|
{
|
logError(ERR_ATTR_SYNTAX_UNKNOWN_ORDERING_MATCHING_RULE.get(
|
OMR_OCTET_STRING_OID, SYNTAX_JPEG_NAME));
|
}
|
|
defaultSubstringMatchingRule =
|
DirectoryServer.getSubstringMatchingRule(SMR_OCTET_STRING_OID);
|
if (defaultSubstringMatchingRule == null)
|
{
|
logError(ERR_ATTR_SYNTAX_UNKNOWN_SUBSTRING_MATCHING_RULE.get(
|
SMR_OCTET_STRING_OID, SYNTAX_JPEG_NAME));
|
}
|
|
this.config = configuration;
|
config.addJPEGChangeListener(this);
|
}
|
|
|
|
/**
|
* Retrieves the common name for this attribute syntax.
|
*
|
* @return The common name for this attribute syntax.
|
*/
|
public String getSyntaxName()
|
{
|
return SYNTAX_JPEG_NAME;
|
}
|
|
|
|
/**
|
* Retrieves the OID for this attribute syntax.
|
*
|
* @return The OID for this attribute syntax.
|
*/
|
public String getOID()
|
{
|
return SYNTAX_JPEG_OID;
|
}
|
|
|
|
/**
|
* Retrieves a description for this attribute syntax.
|
*
|
* @return A description for this attribute syntax.
|
*/
|
public String getDescription()
|
{
|
return SYNTAX_JPEG_DESCRIPTION;
|
}
|
|
|
|
/**
|
* Retrieves the default equality matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default equality matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if equality
|
* matches will not be allowed for this type by default.
|
*/
|
public EqualityMatchingRule getEqualityMatchingRule()
|
{
|
return defaultEqualityMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default ordering matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default ordering matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if ordering
|
* matches will not be allowed for this type by default.
|
*/
|
public OrderingMatchingRule getOrderingMatchingRule()
|
{
|
return defaultOrderingMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default substring matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default substring matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if substring
|
* matches will not be allowed for this type by default.
|
*/
|
public SubstringMatchingRule getSubstringMatchingRule()
|
{
|
return defaultSubstringMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default approximate matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default approximate matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if approximate
|
* matches will not be allowed for this type by default.
|
*/
|
public ApproximateMatchingRule getApproximateMatchingRule()
|
{
|
// There is no approximate matching rule by default.
|
return null;
|
}
|
|
|
|
/**
|
* Indicates whether the provided value is acceptable for use in an attribute
|
* with this syntax. If it is not, then the reason may be appended to the
|
* provided buffer.
|
*
|
* @param value The value for which to make the determination.
|
* @param invalidReason The buffer to which the invalid reason should be
|
* appended.
|
*
|
* @return <CODE>true</CODE> if the provided value is acceptable for use with
|
* this syntax, or <CODE>false</CODE> if not.
|
*/
|
public boolean valueIsAcceptable(ByteSequence value,
|
MessageBuilder invalidReason)
|
{
|
// anything is acceptable if we're not strict.
|
if (!config.isStrictFormat())
|
return true;
|
|
/* JFIF files start:
|
* 0xff 0xd8 0xff 0xe0 LH LL 0x4a 0x46 0x49 0x46 ...
|
* SOI APP0 len "JFIF"
|
*
|
* Exif files (from most digital cameras) start:
|
* 0xff 0xd8 0xff 0xe1 LH LL 0x45 0x78 0x69 0x66 ...
|
* SOI APP1 len "Exif"
|
*
|
* So all legal values must be at least 10 bytes long
|
*/
|
if (value.length() < 10)
|
return false;
|
|
if (value.byteAt(0) != (byte)0xff && value.byteAt(1) != (byte)0xd8)
|
return false;
|
|
if (value.byteAt(2) == (byte)0xff && value.byteAt(3) == (byte)0xe0 &&
|
value.byteAt(6) == 'J' && value.byteAt(7) == 'F' &&
|
value.byteAt(8) == 'I' && value.byteAt(9) == 'F')
|
return true;
|
|
if (value.byteAt(2) == (byte)0xff && value.byteAt(3) == (byte)0xe1 &&
|
value.byteAt(6) == 'E' && value.byteAt(7) == 'x' &&
|
value.byteAt(8) == 'i' && value.byteAt(9) == 'f')
|
return true;
|
|
// No JFIF or Exif header found
|
return false;
|
}
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isConfigurationChangeAcceptable(
|
JPEGAttributeSyntaxCfg configuration,
|
List<Message> unacceptableReasons)
|
{
|
// The configuration will always be acceptable.
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public ConfigChangeResult applyConfigurationChange(
|
JPEGAttributeSyntaxCfg configuration)
|
{
|
this.config = configuration;
|
return new ConfigChangeResult(ResultCode.SUCCESS, false);
|
}
|
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isBinary()
|
{
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isHumanReadable()
|
{
|
return false;
|
}
|
}
|
