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) 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) 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
ApiVersion	getApiVersion() Return the API version in use.
Map<String,Object>	getArguments() Return the invocation arguments.
SecurityContext	getSecurityContext() Return the security context to use for the invocation.

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

public InvocationContext(ApiVersion apiVersion,
                         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:

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

Method Detail

getApiVersion

public ApiVersion getApiVersion()

Return the API version in use.

Returns:

the apiVersion the API version

Since:

2.2.0

getSecurityContext

public SecurityContext getSecurityContext()

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