001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2012-2016 ForgeRock AS.
016 */
017package org.opends.server.schema;
018
019import static org.opends.server.schema.SchemaConstants.*;
020
021import org.forgerock.opendj.ldap.schema.Schema;
022import org.forgerock.opendj.ldap.schema.Syntax;
023import org.forgerock.opendj.server.config.server.AttributeSyntaxCfg;
024import org.opends.server.api.AttributeSyntax;
025
026
027/**
028 * This class implements the fax attribute syntax.  This should be restricted to
029 * holding only fax message contents, but we will accept any set of bytes.  It
030 * will be treated much like the octet string attribute syntax.
031 */
032public class FaxSyntax
033       extends AttributeSyntax<AttributeSyntaxCfg>
034{
035
036  /**
037   * Creates a new instance of this syntax.  Note that the only thing that
038   * should be done here is to invoke the default constructor for the
039   * superclass.  All initialization should be performed in the
040   * <CODE>initializeSyntax</CODE> method.
041   */
042  public FaxSyntax()
043  {
044    super();
045  }
046
047  /** {@inheritDoc} */
048  @Override
049  public Syntax getSDKSyntax(Schema schema)
050  {
051    return schema.getSyntax(SchemaConstants.SYNTAX_FAX_OID);
052  }
053
054  /**
055   * Retrieves the common name for this attribute syntax.
056   *
057   * @return  The common name for this attribute syntax.
058   */
059  @Override
060  public String getName()
061  {
062    return SYNTAX_FAX_NAME;
063  }
064
065  /**
066   * Retrieves the OID for this attribute syntax.
067   *
068   * @return  The OID for this attribute syntax.
069   */
070  @Override
071  public String getOID()
072  {
073    return SYNTAX_FAX_OID;
074  }
075
076  /**
077   * Retrieves a description for this attribute syntax.
078   *
079   * @return  A description for this attribute syntax.
080   */
081  @Override
082  public String getDescription()
083  {
084    return SYNTAX_FAX_DESCRIPTION;
085  }
086}
087