Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2015-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2015-2021 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2015-2021 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.extensions;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.ExtendedRequest;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.sdk.unboundidds.extensions.ExtOpMessages.*;
/**
* This class provides an implementation of an extended request that can be used
* to consume a single-use token that was generated and provided to the user
* through the deliver single-use token extended operation. Once a token has
* been consumed, it cannot be used again, although a new token can be generated
* and delivered to the user if necessary.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*
* This extended request has an OID of "1.3.6.1.4.1.30221.2.6.51" and it must
* have a value with the following encoding:
*
*
* @see DeliverSingleUseTokenExtendedResult
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ConsumeSingleUseTokenExtendedRequest
extends ExtendedRequest
{
/**
* The OID (1.3.6.1.4.1.30221.2.6.51) for the consume single-use token
* extended request.
*/
@NotNull public static final String CONSUME_SINGLE_USE_TOKEN_REQUEST_OID =
"1.3.6.1.4.1.30221.2.6.51";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -3162206445662323272L;
// The identifier for the token to consume.
@NotNull private final String tokenID;
// The value for the single-use token to consume.
@NotNull private final String tokenValue;
// The DN of the user whose account contains the token to consume.
@NotNull private final String userDN;
/**
* Creates a new consume single-use token extended request with the provided
* information.
*
* @param userDN The DN of the user whose account contains the token to
* consume. It must not be {@code null}.
* @param tokenID The identifier for the token to consume. It must not
* be {@code null}.
* @param tokenValue The value for the single-use token to consume. It
* must not be {@code null}.
* @param controls An optional set of controls to include in the request.
* It may be {@code null} or empty if no controls are
* required.
*/
public ConsumeSingleUseTokenExtendedRequest(@NotNull final String userDN,
@NotNull final String tokenID,
@NotNull final String tokenValue,
@Nullable final Control... controls)
{
super(CONSUME_SINGLE_USE_TOKEN_REQUEST_OID,
encodeValue(userDN, tokenID, tokenValue),
controls);
this.userDN = userDN;
this.tokenID = tokenID;
this.tokenValue = tokenValue;
}
/**
* Decodes the provided extended request as a consume single-use token
* extended request.
*
* @param request The extended request to decode as a consume single-use
* token extended request.
*
* @throws LDAPException If the provided extended request cannot be decoded
* as a consume single-use token request.
*/
public ConsumeSingleUseTokenExtendedRequest(
@NotNull final ExtendedRequest request)
throws LDAPException
{
super(request);
final ASN1OctetString value = request.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_CONSUME_SINGLE_USE_TOKEN_REQUEST_NO_VALUE.get());
}
try
{
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(value.getValue()).elements();
userDN = ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
tokenID = ASN1OctetString.decodeAsOctetString(elements[1]).stringValue();
tokenValue =
ASN1OctetString.decodeAsOctetString(elements[2]).stringValue();
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_CONSUME_SINGLE_USE_TOKEN_REQUEST_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Encodes the provided information into an ASN.1 octet string suitable for
* use as the value of the extended request.
*
* @param userDN The DN of the user whose account contains the token to
* consume. It must not be {@code null}.
* @param tokenID The identifier for the token to consume. It must not
* be {@code null}.
* @param tokenValue The value for the single-use token to consume. It
* must not be {@code null}.
*
* @return An ASN.1 octet string containing the encoded value.
*/
@NotNull()
private static ASN1OctetString encodeValue(@NotNull final String userDN,
@NotNull final String tokenID, @NotNull final String tokenValue)
{
Validator.ensureNotNull(userDN);
Validator.ensureNotNull(tokenID);
Validator.ensureNotNull(tokenValue);
final ASN1Sequence valueSequence = new ASN1Sequence(
new ASN1OctetString(userDN),
new ASN1OctetString(tokenID),
new ASN1OctetString(tokenValue));
return new ASN1OctetString(valueSequence.encode());
}
/**
* Retrieves the DN of the user whose account contains the token to consume.
*
* @return The DN of the user whose account contains the token to consume.
*/
@NotNull()
public String getUserDN()
{
return userDN;
}
/**
* Retrieves the identifier for the token to consume.
*
* @return The identifier for the token to consume.
*/
@NotNull()
public String getTokenID()
{
return tokenID;
}
/**
* Retrieves the value for the token to consume.
*
* @return The value for the token to consume.
*/
@NotNull()
public String getTokenValue()
{
return tokenValue;
}
/**
* {@inheritDoc}.
*/
@Override()
@NotNull()
public ConsumeSingleUseTokenExtendedRequest duplicate()
{
return duplicate(getControls());
}
/**
* {@inheritDoc}.
*/
@Override()
@NotNull()
public ConsumeSingleUseTokenExtendedRequest duplicate(
@Nullable final Control[] controls)
{
final ConsumeSingleUseTokenExtendedRequest r =
new ConsumeSingleUseTokenExtendedRequest(userDN, tokenID, tokenValue,
controls);
r.setResponseTimeoutMillis(getResponseTimeoutMillis(null));
return r;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getExtendedRequestName()
{
return INFO_EXTENDED_REQUEST_NAME_CONSUME_SINGLE_USE_TOKEN.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("ConsumeSingleUseTokenExtendedRequest(userDN='");
buffer.append(userDN);
buffer.append("', tokenID='");
buffer.append(tokenID);
buffer.append('\'');
final Control[] controls = getControls();
if (controls.length > 0)
{
buffer.append(", controls={");
for (int i=0; i < controls.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append(controls[i]);
}
buffer.append('}');
}
buffer.append(')');
}
}
