
com.helger.photon.connect.generic.IConnectionDestination Maven / Gradle / Ivy
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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.
*/
package com.helger.photon.connect.generic;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.commons.state.EChange;
import com.helger.security.authentication.credentials.IAuthCredentials;
/**
* Abstract connection destination.
*
* @author philip
* @param
* The handle type to be used.
*/
public interface IConnectionDestination
{
/**
* Connect to the destination.
*
* @param aCredentials
* The credentials to use.
* @return null
if connection could not be established, the
* handle otherwise.
*/
@Nullable
HANDLETYPE openConnection (IAuthCredentials aCredentials);
/**
* Close the connection.
*
* @param aHandle
* The handle returned from {@link #openConnection(IAuthCredentials)} .
* @return {@link EChange}
*/
@Nonnull
EChange closeConnection (HANDLETYPE aHandle);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy