001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2012-2015 ForgeRock AS
026 */
027package org.opends.server.schema;
028
029import static org.opends.server.schema.SchemaConstants.*;
030
031import org.forgerock.opendj.ldap.schema.Schema;
032import org.forgerock.opendj.ldap.schema.Syntax;
033import org.opends.server.admin.std.server.AttributeSyntaxCfg;
034import org.opends.server.api.AttributeSyntax;
035
036
037/**
038 * This class defines the distinguished name attribute syntax, which is used for
039 * attributes that hold distinguished names (DNs).  Equality and substring
040 * matching will be allowed by default.
041 */
042public class DistinguishedNameSyntax
043       extends AttributeSyntax<AttributeSyntaxCfg>
044{
045  /**
046   * Creates a new instance of this syntax.  Note that the only thing that
047   * should be done here is to invoke the default constructor for the
048   * superclass.  All initialization should be performed in the
049   * <CODE>initializeSyntax</CODE> method.
050   */
051  public DistinguishedNameSyntax()
052  {
053    super();
054  }
055
056  /** {@inheritDoc} */
057  @Override
058  public Syntax getSDKSyntax(Schema schema)
059  {
060    return schema.getSyntax(SchemaConstants.SYNTAX_DN_OID);
061  }
062
063  /**
064   * Retrieves the common name for this attribute syntax.
065   *
066   * @return  The common name for this attribute syntax.
067   */
068  @Override
069  public String getName()
070  {
071    return SYNTAX_DN_NAME;
072  }
073
074  /**
075   * Retrieves the OID for this attribute syntax.
076   *
077   * @return  The OID for this attribute syntax.
078   */
079  @Override
080  public String getOID()
081  {
082    return SYNTAX_DN_OID;
083  }
084
085  /**
086   * Retrieves a description for this attribute syntax.
087   *
088   * @return  A description for this attribute syntax.
089   */
090  @Override
091  public String getDescription()
092  {
093    return SYNTAX_DN_DESCRIPTION;
094  }
095}
096