jakarta.resource.spi.security.GenericCredential Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.spi.security;
import jakarta.resource.spi.SecurityException;
/** The interface jakarta.resource.spi.security.GenericCredential
* defines a security mechanism independent interface for accessing
* security credential of a resource principal.
*
* The GenericCredential interface provides a Java
* wrapper over an underlying mechanism specific representation of
* a security credential. For example, the GenericCredential
* interface can be used to wrap Kerberos credentials.
*
*
The connector architecture does not define any standard format
* and requirements for security mechanism specific credentials. For
* example, a security credential wrapped by a GenericCredential
* interface can have a native representation specific to an operating
* system.
*
*
The GenericCredential interface enables a resource adapter to
* extract information about a security credential. The resource adapter
* can then manage EIS sign-on for a resource principal by either:
*
* - using the credentials in an EIS specific manner if the underlying
* EIS supports the security mechanism type represented by the
* GenericCredential instance, or,
*
- using GSS-API if the resource adapter and underlying EIS
* instance support GSS-API.
*
*
* @author Rahul Sharma
* @version 0.7
* @since 0.7
* @see javax.security.auth.Subject
* @see java.security.Principal
* @deprecated The preferred way to represent generic credential information
* is via the org.ietf.jgss.GSSCredential interface in
* J2SE Version 1.4, which provides similar functionality.
*/
public interface GenericCredential {
/** Returns the name of the resource principal associated
* with a GenericCredential instance.
*
* @return Name of the principal
**/
public
String getName();
/** Returns the mechanism type for the GenericCredential instance.
* The mechanism type definition for GenericCredential should be
* consistent with the Object Identifier (OID) based representation
* specified in the GSS specification. In the GenericCredential
* interface, the mechanism type is returned as a stringified
* representation of the OID specification.
*
* @return mechanism type
**/
public
String getMechType();
/** Gets security data for a specific security mechanism represented
* by the GenericCredential. An example is authentication data required
* for establishing a secure association with an EIS instance on
* behalf of the associated resource principal.
*
* The getCredentialData method returns the credential
* representation as an array of bytes. Note that the connector
* architecture does not define any standard format for the returned
* credential data.
*
* @return credential representation as an array of bytes.
* @throws SecurityException
* Failed operation due to security related
* error condition
**/
public
byte[] getCredentialData() throws SecurityException;
/** Tests if this GenericCredential instance refers to the same entity
* as the supplied object. The two credentials must be acquired over
* the same mechanisms and must refer to the same principal.
*
* Returns true if the two GenericCredentials refer to the same entity;
* false otherwise.
**/
public
boolean equals(Object another);
/** Returns the hash code for this GenericCredential
*
* @return hash code for this GenericCredential
**/
public
int hashCode();
}