api/tokens/TokenIdFactory.java

	TokenIdFactory.java revision 71ef1e179613c2e17b9ad5f1c9db6bf533941f9d
/**
 * Copyright 2013 ForgeRock, Inc.
 *
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 */
package com.sun.identity.sm.ldap.api.tokens;

import com.iplanet.dpro.session.SessionID;
import com.iplanet.dpro.session.service.InternalSession;
import com.sun.identity.sm.ldap.api.fields.OAuthTokenField;
import com.sun.identity.sm.ldap.utils.KeyConversion;
import org.forgerock.json.fluent.JsonValue;

import java.util.UUID;

/**
 * Responsible for generating Token Ids and for converting objects into their corresponding Token Ids.
 *
 * @author robert.wapshott@forgerock.com
 */
public class TokenIdFactory {

    private KeyConversion encoding;
    public static final String ID = OAuthTokenField.ID.getOAuthField();

    public TokenIdFactory(KeyConversion encoding) {
        this.encoding = encoding;
    }

    /**
     * @param requestId The request Id to convert to a Token Id.
     * @return Non null Token Id.
     */
    public String toSAMLPrimaryTokenId(String requestId) {
        return encoding.encodeKey(requestId);
    }

    /**
     * @param secondaryKey The secondary key to convert to a Token Id.
     * @return Non null Token Id.
     */
    public String toSAMLSecondaryTokenId(String secondaryKey) {
        return encoding.encodeKey(secondaryKey);
    }

    /**
     * Extract a suitable Id from the InternalSession to use as a Token Id.
     *
     * @param session InternalSession to use.
     * @return Non null Token Id.
     */
    public String toSessionTokenId(InternalSession session) {
        return toSessionTokenId(session.getID());
    }

    /**
     * Extract a suitable Id from the SessionId to use as the Token Id.
     *
     * @param sessionID SessionID to use.
     * @return Non null Token Id.
     */
    public String toSessionTokenId(SessionID sessionID) {
        return encoding.encryptKey(sessionID);
    }

    /**
     * Extract the unique Id from the OAuth Token using the ID.
     *
     * @param request JsonValue of the OAuth Token.
     * @return Non null Token Id.
     */
    public String toOAuthTokenId(JsonValue request) {
        String id = request.get(ID).asString();

        if (id == null){
            id = UUID.randomUUID().toString();
            request.get(ID).setObject(id);
        }

        return id;
    }
}