com.zeroc.Glacier2.SSLSessionManagerPrx Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of glacier2 Show documentation
Show all versions of glacier2 Show documentation
Firewall traversal for Ice
//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.2
//
//
//
// Generated from file `Session.ice'
//
// Warning: do not edit this file.
//
//
//
package com.zeroc.Glacier2;
/**
* The session manager for SSL authenticated users that is
* responsible for managing {@link Session} objects. New session objects are
* created by the {@link Router} object calling on an application-provided
* session manager. If no session manager is provided by the
* application, no client-visible sessions are passed to the client.
*
* @see Router
* @see Session
**/
public interface SSLSessionManagerPrx extends com.zeroc.Ice.ObjectPrx
{
/**
* Create a new session.
* @param info The SSL info.
* @param control A proxy to the session control object.
* @return A proxy to the newly created session.
* @throws CannotCreateSessionException Raised if the session
* cannot be created.
**/
default SessionPrx create(SSLInfo info, SessionControlPrx control)
throws CannotCreateSessionException
{
return create(info, control, com.zeroc.Ice.ObjectPrx.noExplicitContext);
}
/**
* Create a new session.
* @param info The SSL info.
* @param control A proxy to the session control object.
* @param context The Context map to send with the invocation.
* @return A proxy to the newly created session.
* @throws CannotCreateSessionException Raised if the session
* cannot be created.
**/
default SessionPrx create(SSLInfo info, SessionControlPrx control, java.util.Map context)
throws CannotCreateSessionException
{
try
{
return _iceI_createAsync(info, control, context, true).waitForResponseOrUserEx();
}
catch(CannotCreateSessionException ex)
{
throw ex;
}
catch(com.zeroc.Ice.UserException ex)
{
throw new com.zeroc.Ice.UnknownUserException(ex.ice_id(), ex);
}
}
/**
* Create a new session.
* @param info The SSL info.
* @param control A proxy to the session control object.
* @return A proxy to the newly created session.
**/
default java.util.concurrent.CompletableFuture createAsync(SSLInfo info, SessionControlPrx control)
{
return _iceI_createAsync(info, control, com.zeroc.Ice.ObjectPrx.noExplicitContext, false);
}
/**
* Create a new session.
* @param info The SSL info.
* @param control A proxy to the session control object.
* @param context The Context map to send with the invocation.
* @return A proxy to the newly created session.
**/
default java.util.concurrent.CompletableFuture createAsync(SSLInfo info, SessionControlPrx control, java.util.Map context)
{
return _iceI_createAsync(info, control, context, false);
}
/**
* @hidden
* @param iceP_info -
* @param iceP_control -
* @param context -
* @param sync -
* @return -
**/
default com.zeroc.IceInternal.OutgoingAsync _iceI_createAsync(SSLInfo iceP_info, SessionControlPrx iceP_control, java.util.Map context, boolean sync)
{
com.zeroc.IceInternal.OutgoingAsync f = new com.zeroc.IceInternal.OutgoingAsync<>(this, "create", null, sync, _iceE_create);
f.invoke(true, context, com.zeroc.Ice.FormatType.SlicedFormat, ostr -> {
SSLInfo.ice_write(ostr, iceP_info);
ostr.writeProxy(iceP_control);
}, istr -> {
SessionPrx ret;
ret = SessionPrx.uncheckedCast(istr.readProxy());
return ret;
});
return f;
}
/** @hidden */
static final Class[] _iceE_create =
{
CannotCreateSessionException.class
};
/**
* Contacts the remote server to verify that the object implements this type.
* Raises a local exception if a communication error occurs.
* @param obj The untyped proxy.
* @return A proxy for this type, or null if the object does not support this type.
**/
static SSLSessionManagerPrx checkedCast(com.zeroc.Ice.ObjectPrx obj)
{
return com.zeroc.Ice.ObjectPrx._checkedCast(obj, ice_staticId(), SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Contacts the remote server to verify that the object implements this type.
* Raises a local exception if a communication error occurs.
* @param obj The untyped proxy.
* @param context The Context map to send with the invocation.
* @return A proxy for this type, or null if the object does not support this type.
**/
static SSLSessionManagerPrx checkedCast(com.zeroc.Ice.ObjectPrx obj, java.util.Map context)
{
return com.zeroc.Ice.ObjectPrx._checkedCast(obj, context, ice_staticId(), SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Contacts the remote server to verify that a facet of the object implements this type.
* Raises a local exception if a communication error occurs.
* @param obj The untyped proxy.
* @param facet The name of the desired facet.
* @return A proxy for this type, or null if the object does not support this type.
**/
static SSLSessionManagerPrx checkedCast(com.zeroc.Ice.ObjectPrx obj, String facet)
{
return com.zeroc.Ice.ObjectPrx._checkedCast(obj, facet, ice_staticId(), SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Contacts the remote server to verify that a facet of the object implements this type.
* Raises a local exception if a communication error occurs.
* @param obj The untyped proxy.
* @param facet The name of the desired facet.
* @param context The Context map to send with the invocation.
* @return A proxy for this type, or null if the object does not support this type.
**/
static SSLSessionManagerPrx checkedCast(com.zeroc.Ice.ObjectPrx obj, String facet, java.util.Map context)
{
return com.zeroc.Ice.ObjectPrx._checkedCast(obj, facet, context, ice_staticId(), SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Downcasts the given proxy to this type without contacting the remote server.
* @param obj The untyped proxy.
* @return A proxy for this type.
**/
static SSLSessionManagerPrx uncheckedCast(com.zeroc.Ice.ObjectPrx obj)
{
return com.zeroc.Ice.ObjectPrx._uncheckedCast(obj, SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Downcasts the given proxy to this type without contacting the remote server.
* @param obj The untyped proxy.
* @param facet The name of the desired facet.
* @return A proxy for this type.
**/
static SSLSessionManagerPrx uncheckedCast(com.zeroc.Ice.ObjectPrx obj, String facet)
{
return com.zeroc.Ice.ObjectPrx._uncheckedCast(obj, facet, SSLSessionManagerPrx.class, _SSLSessionManagerPrxI.class);
}
/**
* Returns a proxy that is identical to this proxy, except for the per-proxy context.
* @param newContext The context for the new proxy.
* @return A proxy with the specified per-proxy context.
**/
@Override
default SSLSessionManagerPrx ice_context(java.util.Map newContext)
{
return (SSLSessionManagerPrx)_ice_context(newContext);
}
/**
* Returns a proxy that is identical to this proxy, except for the adapter ID.
* @param newAdapterId The adapter ID for the new proxy.
* @return A proxy with the specified adapter ID.
**/
@Override
default SSLSessionManagerPrx ice_adapterId(String newAdapterId)
{
return (SSLSessionManagerPrx)_ice_adapterId(newAdapterId);
}
/**
* Returns a proxy that is identical to this proxy, except for the endpoints.
* @param newEndpoints The endpoints for the new proxy.
* @return A proxy with the specified endpoints.
**/
@Override
default SSLSessionManagerPrx ice_endpoints(com.zeroc.Ice.Endpoint[] newEndpoints)
{
return (SSLSessionManagerPrx)_ice_endpoints(newEndpoints);
}
/**
* Returns a proxy that is identical to this proxy, except for the locator cache timeout.
* @param newTimeout The new locator cache timeout (in seconds).
* @return A proxy with the specified locator cache timeout.
**/
@Override
default SSLSessionManagerPrx ice_locatorCacheTimeout(int newTimeout)
{
return (SSLSessionManagerPrx)_ice_locatorCacheTimeout(newTimeout);
}
/**
* Returns a proxy that is identical to this proxy, except for the invocation timeout.
* @param newTimeout The new invocation timeout (in seconds).
* @return A proxy with the specified invocation timeout.
**/
@Override
default SSLSessionManagerPrx ice_invocationTimeout(int newTimeout)
{
return (SSLSessionManagerPrx)_ice_invocationTimeout(newTimeout);
}
/**
* Returns a proxy that is identical to this proxy, except for connection caching.
* @param newCache true if the new proxy should cache connections; false otherwise.
* @return A proxy with the specified caching policy.
**/
@Override
default SSLSessionManagerPrx ice_connectionCached(boolean newCache)
{
return (SSLSessionManagerPrx)_ice_connectionCached(newCache);
}
/**
* Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
* @param newType The new endpoint selection policy.
* @return A proxy with the specified endpoint selection policy.
**/
@Override
default SSLSessionManagerPrx ice_endpointSelection(com.zeroc.Ice.EndpointSelectionType newType)
{
return (SSLSessionManagerPrx)_ice_endpointSelection(newType);
}
/**
* Returns a proxy that is identical to this proxy, except for how it selects endpoints.
* @param b If b is true, only endpoints that use a secure transport are
* used by the new proxy. If b is false, the returned proxy uses both secure and
* insecure endpoints.
* @return A proxy with the specified selection policy.
**/
@Override
default SSLSessionManagerPrx ice_secure(boolean b)
{
return (SSLSessionManagerPrx)_ice_secure(b);
}
/**
* Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
* @param e The encoding version to use to marshal request parameters.
* @return A proxy with the specified encoding version.
**/
@Override
default SSLSessionManagerPrx ice_encodingVersion(com.zeroc.Ice.EncodingVersion e)
{
return (SSLSessionManagerPrx)_ice_encodingVersion(e);
}
/**
* Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
* @param b If b is true, the new proxy will use secure endpoints for invocations
* and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is
* false, the proxy prefers insecure endpoints to secure ones.
* @return A proxy with the specified selection policy.
**/
@Override
default SSLSessionManagerPrx ice_preferSecure(boolean b)
{
return (SSLSessionManagerPrx)_ice_preferSecure(b);
}
/**
* Returns a proxy that is identical to this proxy, except for the router.
* @param router The router for the new proxy.
* @return A proxy with the specified router.
**/
@Override
default SSLSessionManagerPrx ice_router(com.zeroc.Ice.RouterPrx router)
{
return (SSLSessionManagerPrx)_ice_router(router);
}
/**
* Returns a proxy that is identical to this proxy, except for the locator.
* @param locator The locator for the new proxy.
* @return A proxy with the specified locator.
**/
@Override
default SSLSessionManagerPrx ice_locator(com.zeroc.Ice.LocatorPrx locator)
{
return (SSLSessionManagerPrx)_ice_locator(locator);
}
/**
* Returns a proxy that is identical to this proxy, except for collocation optimization.
* @param b true if the new proxy enables collocation optimization; false otherwise.
* @return A proxy with the specified collocation optimization.
**/
@Override
default SSLSessionManagerPrx ice_collocationOptimized(boolean b)
{
return (SSLSessionManagerPrx)_ice_collocationOptimized(b);
}
/**
* Returns a proxy that is identical to this proxy, but uses twoway invocations.
* @return A proxy that uses twoway invocations.
**/
@Override
default SSLSessionManagerPrx ice_twoway()
{
return (SSLSessionManagerPrx)_ice_twoway();
}
/**
* Returns a proxy that is identical to this proxy, but uses oneway invocations.
* @return A proxy that uses oneway invocations.
**/
@Override
default SSLSessionManagerPrx ice_oneway()
{
return (SSLSessionManagerPrx)_ice_oneway();
}
/**
* Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
* @return A proxy that uses batch oneway invocations.
**/
@Override
default SSLSessionManagerPrx ice_batchOneway()
{
return (SSLSessionManagerPrx)_ice_batchOneway();
}
/**
* Returns a proxy that is identical to this proxy, but uses datagram invocations.
* @return A proxy that uses datagram invocations.
**/
@Override
default SSLSessionManagerPrx ice_datagram()
{
return (SSLSessionManagerPrx)_ice_datagram();
}
/**
* Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
* @return A proxy that uses batch datagram invocations.
**/
@Override
default SSLSessionManagerPrx ice_batchDatagram()
{
return (SSLSessionManagerPrx)_ice_batchDatagram();
}
/**
* Returns a proxy that is identical to this proxy, except for compression.
* @param co true enables compression for the new proxy; false disables compression.
* @return A proxy with the specified compression setting.
**/
@Override
default SSLSessionManagerPrx ice_compress(boolean co)
{
return (SSLSessionManagerPrx)_ice_compress(co);
}
/**
* Returns a proxy that is identical to this proxy, except for its connection timeout setting.
* @param t The connection timeout for the proxy in milliseconds.
* @return A proxy with the specified timeout.
**/
@Override
default SSLSessionManagerPrx ice_timeout(int t)
{
return (SSLSessionManagerPrx)_ice_timeout(t);
}
/**
* Returns a proxy that is identical to this proxy, except for its connection ID.
* @param connectionId The connection ID for the new proxy. An empty string removes the connection ID.
* @return A proxy with the specified connection ID.
**/
@Override
default SSLSessionManagerPrx ice_connectionId(String connectionId)
{
return (SSLSessionManagerPrx)_ice_connectionId(connectionId);
}
/**
* Returns a proxy that is identical to this proxy, except it's a fixed proxy bound
* the given connection.@param connection The fixed proxy connection.
* @return A fixed proxy bound to the given connection.
**/
@Override
default SSLSessionManagerPrx ice_fixed(com.zeroc.Ice.Connection connection)
{
return (SSLSessionManagerPrx)_ice_fixed(connection);
}
static String ice_staticId()
{
return "::Glacier2::SSLSessionManager";
}
}