TokenPersistenceProcessor.java

/*
 * Copyright (c) 2013, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. licenses this file to you 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.
 */

package org.wso2.carbon.identity.oauth.tokenprocessor;

import org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception;

/**
 * <Code>TokenPersistenceProcessor</Code> implementations are used to
 * process keys and secrets just before storing them in the database.
 * E.g. to encrypt tokens before storing them in the database.
 * Implementations of this interface can be configured through
 * the identity.xml.
 */
public interface TokenPersistenceProcessor {

    public String getProcessedClientId(String clientId) throws IdentityOAuth2Exception;

    public String getPreprocessedClientId(String processedClientId) throws IdentityOAuth2Exception;

    public String getProcessedClientSecret(String clientSecret) throws IdentityOAuth2Exception;

    public String getPreprocessedClientSecret(String processedClientSecret) throws IdentityOAuth2Exception;

    public String getProcessedAuthzCode(String authzCode) throws IdentityOAuth2Exception;

    public String getPreprocessedAuthzCode(String processedAuthzCode) throws IdentityOAuth2Exception;

    public String getProcessedAccessTokenIdentifier(String accessTokenIdentifier) throws IdentityOAuth2Exception;

    public String getPreprocessedAccessTokenIdentifier(String processedAccessTokenIdentifier)
            throws IdentityOAuth2Exception;

    public String getProcessedRefreshToken(String refreshToken) throws IdentityOAuth2Exception;

    public String getPreprocessedRefreshToken(String processedRefreshToken)
            throws IdentityOAuth2Exception;

}