org.jenkinsci.remoting

Class RoleChecker

java.lang.Object

org.jenkinsci.remoting.RoleChecker

public abstract class RoleChecker
extends Object

Verifies that the callable is getting run on the intended recipient.

Since:

2.47

Author:

Kohsuke Kawaguchi

See Also:

ChannelBuilder.withRoleChecker(RoleChecker)

Constructor Summary

Constructors

Constructor and Description
RoleChecker()

Method Summary

Modifier and Type	Method and Description
abstract void	check(RoleSensitive subject, Collection<Role> expected) Called from RoleSensitive.checkRoles(RoleChecker) to ensure that this side of the channel is willing to execute Callables that expects one of the given roles on their intended recipients.
void	check(RoleSensitive subject, Role... expected)
void	check(RoleSensitive subject, Role expected)

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleChecker

public RoleChecker()

Method Detail

check

public abstract void check(@Nonnull
                           RoleSensitive subject,
                           @Nonnull
                           Collection<Role> expected)
                    throws SecurityException

Called from RoleSensitive.checkRoles(RoleChecker) to ensure that this side of the channel is willing to execute Callables that expects one of the given roles on their intended recipients.

If you think you need to implement RoleSensitive.checkRoles(org.jenkinsci.remoting.RoleChecker) please reread that method’s Javadoc.

Normally, each side of the channel has a fixed set of roles (say actualRoles), and the implementation would be actualRoles.containsAll(roles).

Parameters:

subject - Object whose role we are checking right now. Useful context information when reporting an error.

expected - The current JVM that executes the callable should have one of these roles. Never null. Use an empty collection to indicate that any channel can execute a given callable without restriction. Unless you are extremely careful, this is likely to result in a security vulnerability. Doing this is strongly discouraged.

Throws:

SecurityException - Any exception thrown will prevent the callable from getting executed, but we recommend SecurityException

check

public void check(@Nonnull
                  RoleSensitive subject,
                  @Nonnull
                  Role expected)
           throws SecurityException

Throws:

SecurityException

check

public void check(@Nonnull
                  RoleSensitive subject,
                  Role... expected)
           throws SecurityException

Throws:

SecurityException