org.rundeck.app.acl

Class BaseContextACLManager<T>

java.lang.Object

org.rundeck.app.acl.BaseContextACLManager<T>

Type Parameters:

T -

All Implemented Interfaces:

ContextACLManager<T>, ContextValidator<T>

Direct Known Subclasses:

ContextACLStorageFileManager

public abstract class BaseContextACLManager<T>
extends java.lang.Object
implements ContextACLManager<T>

Base context acl manager, uses forContext(Object) to retrieve ACLFilemanager, and apply corresponding method call, maintains created managers in a map, and handles listener mappings for the created managers

Constructor Summary

Constructors

Constructor and Description
BaseContextACLManager()

Method Summary

Modifier and Type	Method and Description
void	addListener(T context, ACLFileManagerListener listener) Receive notification of changes
void	addListenerMap(java.util.function.Function<T,ACLFileManagerListener> mapping) adds a mapping from context to listeners, and immediately applies to previously created managers
protected ACLFileManager	applyMappings(T ctx, ACLFileManager listenable) Applies existing listener mappings to a manager
protected abstract ACLFileManager	createManager(T context)
boolean	deletePolicyFile(T context, java.lang.String fileName) Delete a policy file
boolean	existsPolicyFile(T context, java.lang.String file)
ACLFileManager	forContext(T context)
AclPolicyFile	getAclPolicy(T context, java.lang.String fileName) Retrieve a system policy
java.lang.String	getPolicyFileContents(T context, java.lang.String fileName)
java.util.List<java.lang.String>	listStoredPolicyFiles(T context) List the system aclpolicy file names, not including the dir path
long	loadPolicyFileContents(T context, java.lang.String fileName, java.io.OutputStream outputStream) Load content to output stream
void	removeListener(T context, ACLFileManagerListener listener) Remove a listener
long	storePolicyFile(T context, java.lang.String fileName, java.io.InputStream input) Store a system policy file
long	storePolicyFileContents(T context, java.lang.String fileName, java.lang.String fileText) Store a system policy file
com.dtolabs.rundeck.core.authorization.RuleSetValidation<com.dtolabs.rundeck.core.authorization.providers.PolicyCollection>	validatePolicyFile(T context, java.lang.String fname) Validate the yaml aclpolicy within a specific project context
com.dtolabs.rundeck.core.authorization.RuleSetValidation<com.dtolabs.rundeck.core.authorization.providers.PolicyCollection>	validateYamlPolicy(T context, java.lang.String ident, java.lang.String text) Validate the yaml aclpolicy, optionally within a specific project context

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseContextACLManager

public BaseContextACLManager()

Method Detail

applyMappings

protected ACLFileManager applyMappings(T ctx,
                                       ACLFileManager listenable)

Applies existing listener mappings to a manager

Parameters:

ctx - context

listenable - manager

createManager

protected abstract ACLFileManager createManager(T context)

Returns:

create a manager based on context

forContext

public ACLFileManager forContext(T context)

Specified by:

forContext in interface ContextACLManager<T>

addListenerMap

public void addListenerMap(java.util.function.Function<T,ACLFileManagerListener> mapping)

adds a mapping from context to listeners, and immediately applies to previously created managers

Specified by:

addListenerMap in interface ContextACLManager<T>

Parameters:

mapping -

addListener

public void addListener(T context,
                        ACLFileManagerListener listener)

Description copied from interface: ContextACLManager

Receive notification of changes

Specified by:

addListener in interface ContextACLManager<T>

removeListener

public void removeListener(T context,
                           ACLFileManagerListener listener)

Description copied from interface: ContextACLManager

Remove a listener

Specified by:

removeListener in interface ContextACLManager<T>

storePolicyFile

public long storePolicyFile(T context,
                            java.lang.String fileName,
                            java.io.InputStream input)
                     throws java.io.IOException

Description copied from interface: ContextACLManager

Store a system policy file

Specified by:

storePolicyFile in interface ContextACLManager<T>

fileName - name without path

input - input stream

Returns:

size of bytes stored

Throws:

java.io.IOException

deletePolicyFile

public boolean deletePolicyFile(T context,
                                java.lang.String fileName)
                         throws java.io.IOException

Description copied from interface: ContextACLManager

Delete a policy file

Specified by:

deletePolicyFile in interface ContextACLManager<T>

Returns:

true if successful

Throws:

java.io.IOException

storePolicyFileContents

public long storePolicyFileContents(T context,
                                    java.lang.String fileName,
                                    java.lang.String fileText)
                             throws java.io.IOException

Description copied from interface: ContextACLManager

Store a system policy file

Specified by:

storePolicyFileContents in interface ContextACLManager<T>

fileName - name without path

fileText - contents

Returns:

size of bytes stored

Throws:

java.io.IOException

getAclPolicy

public AclPolicyFile getAclPolicy(T context,
                                  java.lang.String fileName)

Description copied from interface: ContextACLManager

Retrieve a system policy

Specified by:

getAclPolicy in interface ContextACLManager<T>

fileName - name without path

Returns:

definition

getPolicyFileContents

public java.lang.String getPolicyFileContents(T context,
                                              java.lang.String fileName)
                                       throws java.io.IOException

Specified by:

getPolicyFileContents in interface ContextACLManager<T>

fileName - name of policy file, without path

Returns:

text contents of the policy file

Throws:

java.io.IOException

loadPolicyFileContents

public long loadPolicyFileContents(T context,
                                   java.lang.String fileName,
                                   java.io.OutputStream outputStream)
                            throws java.io.IOException

Description copied from interface: ContextACLManager

Load content to output stream

Specified by:

loadPolicyFileContents in interface ContextACLManager<T>

fileName - name of policy file, without path

Returns:

length of output

Throws:

java.io.IOException

existsPolicyFile

public boolean existsPolicyFile(T context,
                                java.lang.String file)

Specified by:

existsPolicyFile in interface ContextACLManager<T>

file - name without path

Returns:

true if the policy file with the given name exists

validateYamlPolicy

public com.dtolabs.rundeck.core.authorization.RuleSetValidation<com.dtolabs.rundeck.core.authorization.providers.PolicyCollection> validateYamlPolicy(T context,
                                                                                                                                                      java.lang.String ident,
                                                                                                                                                      java.lang.String text)
                                                                                                                                               throws java.io.IOException

Description copied from interface: ContextValidator

Validate the yaml aclpolicy, optionally within a specific project context

Specified by:

validateYamlPolicy in interface ContextValidator<T>

ident - identity string for the sources

text - yaml aclpolicy text

Returns:

validation

Throws:

java.io.IOException

validatePolicyFile

public com.dtolabs.rundeck.core.authorization.RuleSetValidation<com.dtolabs.rundeck.core.authorization.providers.PolicyCollection> validatePolicyFile(T context,
                                                                                                                                                      java.lang.String fname)
                                                                                                                                               throws java.io.IOException

Description copied from interface: ContextValidator

Validate the yaml aclpolicy within a specific project context

Specified by:

validatePolicyFile in interface ContextValidator<T>

fname - filename

Returns:

validation

Throws:

java.io.IOException

listStoredPolicyFiles

public java.util.List<java.lang.String> listStoredPolicyFiles(T context)

Description copied from interface: ContextACLManager

List the system aclpolicy file names, not including the dir path

Specified by:

listStoredPolicyFiles in interface ContextACLManager<T>