com.atlassian.servicedesk.api.customer

Interface CustomerContextService

public interface CustomerContextService

A Service Desk customer context allows any "named user" access to JIRA Service Desk and JIRA Platform services.

This service allows you to setup customer context, execute some code and have the special JIRA Service Desk permissions apply to that called code.

Normally on the JIRA platform, only licensed users can login and get permission-ed access to services. JIRA Service Desk, however, allows exceptions to this. In JIRA Service Desk EVERY named user is considered a "customer" when they are asking for help. This service allows you to enter a "customer context" to run code in the name of that user (free or otherwise).

WARNING : It is a breach of the JIRA and JIRA Service Desk licence agreements to use this mechanism to subvert the software's terms and conditions. You must only use these methods when you are calling code services on behalf of customers, where that work is related to JIRA Service Desk.

Method Summary

Modifier and Type	Method and Description
<T> T	inCustomerContext(Callable<T> callable) Deprecated. Use runInCustomerContext(NoExceptionsCallable) instead. Boxing underlying exceptions causes log spam due to BrokenPipeExceptions being boxed and hence not recognised as such
void	inCustomerContext(Runnable runnable) Deprecated. use runInCustomerContext(NoExceptionsCallable) instead
boolean	isInCustomerContext()
<T> T	outOfCustomerContext(Callable<T> callable) Deprecated. Use runOutOfCustomerContext(NoExceptionsCallable) instead. Boxing underlying exceptions causes log spam due to BrokenPipeExceptions being boxed and hence not recognised as such
void	outOfCustomerContext(Runnable runnable) Deprecated. use runOutOfCustomerContext(NoExceptionsCallable) instead
<T> T	runInCustomerContext(NoExceptionsCallable<T> callable) Executes the code in a "customer context".
void	runInCustomerContext(Runnable runnable) Executes the code in a "customer context".
<T> T	runOutOfCustomerContext(NoExceptionsCallable<T> callable) Executes the code out of a "customer context".
void	runOutOfCustomerContext(Runnable runnable) Executes the code out of a "customer context".

Method Detail

runInCustomerContext

<T> T runInCustomerContext(NoExceptionsCallable<T> callable)

Executes the code in a "customer context". The special JIRA Service Desk permissions will apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Type Parameters:

T - the return type

Parameters:

callable - the code to execute

Returns:

T the callable returned value

runInCustomerContext

void runInCustomerContext(Runnable runnable)

Executes the code in a "customer context". The special JIRA Service Desk permissions will apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Parameters:

runnable - the code to execute

inCustomerContext

@Deprecated
<T> T inCustomerContext(Callable<T> callable)

Deprecated. Use runInCustomerContext(NoExceptionsCallable) instead. Boxing underlying exceptions causes log spam due to BrokenPipeExceptions being boxed and hence not recognised as such

Executes the code in a "customer context". The special JIRA Service Desk permissions will apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Type Parameters:

T - the return type

Parameters:

callable - the code to execute

Returns:

T the callable returned value

Throws:

RuntimeException - - a mapping of an Callable Exception to a runtime exception

inCustomerContext

@Deprecated
void inCustomerContext(Runnable runnable)

Deprecated. use runInCustomerContext(NoExceptionsCallable) instead

Executes the code in a "customer context". The special JIRA Service Desk permissions will apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Parameters:

runnable - the code to execute

runOutOfCustomerContext

<T> T runOutOfCustomerContext(NoExceptionsCallable<T> callable)

Executes the code out of a "customer context". The special JIRA Service Desk permissions will NOT apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Type Parameters:

T - the return type

Parameters:

callable - the code to execute

Returns:

T the callable returned value

runOutOfCustomerContext

void runOutOfCustomerContext(Runnable runnable)

Executes the code out of a "customer context". The special JIRA Service Desk permissions will NOT apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Parameters:

runnable - the code to execute

outOfCustomerContext

@Deprecated
<T> T outOfCustomerContext(Callable<T> callable)

Deprecated. Use runOutOfCustomerContext(NoExceptionsCallable) instead. Boxing underlying exceptions causes log spam due to BrokenPipeExceptions being boxed and hence not recognised as such

Executes the code out of a "customer context". The special JIRA Service Desk permissions will NOT apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Type Parameters:

T - the return type

Parameters:

callable - the code to execute

Returns:

T the callable returned value

Throws:

RuntimeException - - a mapping of an Callable Exception to a runtime exception

outOfCustomerContext

@Deprecated
void outOfCustomerContext(Runnable runnable)

Deprecated. use runOutOfCustomerContext(NoExceptionsCallable) instead

Executes the code out of a "customer context". The special JIRA Service Desk permissions will NOT apply to this call context.

This method is re-entrant and can be called multiple times within the same thread.

Parameters:

runnable - the code to execute

isInCustomerContext

boolean isInCustomerContext()

Returns:

true if the running code is currently inside a customer context