kv-3.5.2.src.oracle.kv.ReauthenticateHandler Maven / Gradle / Ivy
Show all versions of oracle-nosql-client Show documentation
/*-
*
* This file is part of Oracle NoSQL Database
* Copyright (C) 2011, 2015 Oracle and/or its affiliates. All rights reserved.
*
* If you have received this file as part of Oracle NoSQL Database the
* following applies to the work as a whole:
*
* Oracle NoSQL Database server software is free software: you can
* redistribute it and/or modify it under the terms of the GNU Affero
* General Public License as published by the Free Software Foundation,
* version 3.
*
* Oracle NoSQL Database 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
* Affero General Public License for more details.
*
* If you have received this file as part of Oracle NoSQL Database Client or
* distributed separately the following applies:
*
* Oracle NoSQL Database client software is free software: you can
* redistribute it and/or modify it under the terms of the Apache License
* as published by the Apache Software Foundation, version 2.0.
*
* You should have received a copy of the GNU Affero General Public License
* and/or the Apache License in the LICENSE file along with Oracle NoSQL
* Database client or server distribution. If not, see
* .
*
* An active Oracle commercial licensing agreement for this product supersedes
* these licenses and in such case the license notices, but not the copyright
* notice, may be removed by you in connection with your distribution that is
* in accordance with the commercial licensing terms.
*
* For more information please contact:
*
* [email protected]
*
*/
package oracle.kv;
/**
* A callback interface used when KVStore authentication has expired and
* requires renewal. When an application calls the KVStoreFactory.getStore()
* method and passes in a LoginCredentials object, it may also pass in an
* instance of an object that implements this interface. The object will be
* used to re-establish a login without interrupting the sequence of
* KVStore calls.
*
* @since 3.0
*/
public interface ReauthenticateHandler {
/**
* Attempts to re-authenticate a kvstore handle. When an instance of this
* interface is provided in a call to KVStoreFactory.getStore(), this
* method is called by the KVStore client to perform the re-authentication
* needed to continue an operation on the store that would otherwise
* result in an AuthenticationRequiredException being thrown. The
* implementation should call KVStore.login() with valid credentials that
* match the user identity that was provided when the store was opened.
* If this method returns without throwing an exception but without
* successfully performing a re-authentication, the original
* AuthenticationRequiredException is re-thrown, bypassing this
* ReauthenticationHandler instance.
*
* This method should typically handle any {@link FaultException}s
* thrown by any calls made by its implementation. Any runtime exceptions
* thrown by this method will cause the original operation to fail by
* rethrowing an exception that will be seen by the application. If the
* FaultException thrown by the reauthenticate method is a
* KVSecurityException then the exception re-thrown to the application is
* the original AuthenticationRequiredException, otherwise the exception
* thrown by the reauthenticate method is re-thrown to the application.
*
* @param kvstore The KVStore instance that requires reauthentication
* @throws RuntimeException if the reauthentication failed
*/
void reauthenticate(KVStore kvstore)
throws RuntimeException;
}