org.springframework.boot.actuate.endpoint

Class InvocationContext

java.lang.Object

org.springframework.boot.actuate.endpoint.InvocationContext

public class InvocationContext
extends Object

The context for the invocation of an operation.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
InvocationContext(ApiVersion apiVersion, SecurityContext securityContext, Map<String,Object> arguments) Deprecated. since 2.5.0 for removal in 2.7.0 in favor of InvocationContext(SecurityContext, Map, OperationArgumentResolver[])
InvocationContext(SecurityContext securityContext, Map<String,Object> arguments) Creates a new context for an operation being invoked by the given securityContext with the given available arguments.
InvocationContext(SecurityContext securityContext, Map<String,Object> arguments, OperationArgumentResolver... argumentResolvers) Creates a new context for an operation being invoked by the given securityContext with the given available arguments.

Method Summary

Modifier and Type	Method and Description
boolean	canResolve(Class<?> type) Returns whether the context is capable of resolving an argument of the given type.
ApiVersion	getApiVersion() Deprecated. since 2.5.0 for removal in 2.7.0 in favor of resolveArgument(Class) using ApiVersion
Map<String,Object>	getArguments() Return the invocation arguments.
SecurityContext	getSecurityContext() Deprecated. since 2.5.0 for removal in 2.7.0 in favor of resolveArgument(Class)
<T> T	resolveArgument(Class<T> argumentType) Resolves an argument with the given argumentType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvocationContext

public InvocationContext(SecurityContext securityContext,
                         Map<String,Object> arguments)

Creates a new context for an operation being invoked by the given securityContext with the given available arguments.

Parameters:

securityContext - the current security context. Never null

arguments - the arguments available to the operation. Never null

InvocationContext

@Deprecated
public InvocationContext(ApiVersion apiVersion,
                                     SecurityContext securityContext,
                                     Map<String,Object> arguments)

Deprecated. since 2.5.0 for removal in 2.7.0 in favor of InvocationContext(SecurityContext, Map, OperationArgumentResolver[])

Creates a new context for an operation being invoked by the given securityContext with the given available arguments.

Parameters:

apiVersion - the API version or null to use the latest

securityContext - the current security context. Never null

arguments - the arguments available to the operation. Never null

Since:

2.2.0

InvocationContext

public InvocationContext(SecurityContext securityContext,
                         Map<String,Object> arguments,
                         OperationArgumentResolver... argumentResolvers)

Creates a new context for an operation being invoked by the given securityContext with the given available arguments.

Parameters:

securityContext - the current security context. Never null

arguments - the arguments available to the operation. Never null

argumentResolvers - resolvers for additional arguments should be available to the operation.

Method Detail

getApiVersion

@Deprecated
public ApiVersion getApiVersion()

Deprecated. since 2.5.0 for removal in 2.7.0 in favor of resolveArgument(Class) using ApiVersion

Return the API version in use.

Returns:

the apiVersion the API version

Since:

2.2.0

getSecurityContext

@Deprecated
public SecurityContext getSecurityContext()

Deprecated. since 2.5.0 for removal in 2.7.0 in favor of resolveArgument(Class)

Return the security context to use for the invocation.

Returns:

the security context

getArguments

public Map<String,Object> getArguments()

Return the invocation arguments.

Returns:

the arguments

resolveArgument

public <T> T resolveArgument(Class<T> argumentType)

Resolves an argument with the given argumentType.

Type Parameters:

T - type of the argument

Parameters:

argumentType - type of the argument

Returns:

resolved argument of the required type or null

Since:

2.5.0

See Also:

canResolve(Class)

canResolve

public boolean canResolve(Class<?> type)

Returns whether the context is capable of resolving an argument of the given type. Note that, even when true is returned, argument resolution will return null if no argument of the required type is available.

Parameters:

type - argument type

Returns:

true if resolution of arguments of the given type is possible, otherwise false.

Since:

2.5.0

See Also:

resolveArgument(Class)