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 */
016package org.opends.server.protocols.jmx;
017
018import org.opends.server.api.ClientConnection;
019
020
021/**
022 * Represents a Ldap credential used for JMX connection authentication.
023 * <p>
024 * In JMX Connection, one and only one instance of this class is expected
025 * to be found in each of the <code>publicCredentials</code> and
026 * <code>privateCredentials</code> sets of
027 * {@link javax.security.auth.Subject}. Those are the Jmx Client connection
028 * that will handle incoming requests.
029 */
030public class Credential
031{
032  /**
033   * The Client connection to be used.
034   */
035  private ClientConnection clientConnection;
036
037
038  /**
039   * Default Constructor.
040   *
041   * @param clientConnection
042   *           The  representation of this credential is a Jmx Client connection
043   * that will handle incoming requests.
044   */
045  public Credential(ClientConnection clientConnection)
046  {
047    this.clientConnection = clientConnection;
048  }
049
050  /**
051   * Returns the associated Client connection.
052   *
053   * @return the associated ClientConnection object. Can be null
054   */
055  public ClientConnection getClientConnection()
056  {
057    return clientConnection;
058  }
059}