org.rundeck.app.acl

Interface ACLFileManager

All Known Implementing Classes:

ACLFSFileManager, ACLStorageFileManager, DelegateACLFileManager, ListenableACLFileManager

public interface ACLFileManager

Method Summary

Modifier and Type	Method and Description
default void	addListener(ACLFileManagerListener listener) Receive notification of changes
boolean	deletePolicyFile(java.lang.String fileName) Delete a policy file
boolean	existsPolicyFile(java.lang.String file)
AclPolicyFile	getAclPolicy(java.lang.String fileName) Retrieve a system policy
java.lang.String	getPolicyFileContents(java.lang.String fileName)
com.dtolabs.rundeck.core.authorization.providers.BaseValidator	getValidator()
java.util.List<java.lang.String>	listStoredPolicyFiles() List the system aclpolicy file names, not including the dir path
long	loadPolicyFileContents(java.lang.String fileName, java.io.OutputStream outputStream) Load content to output stream
default void	removeListener(ACLFileManagerListener listener) Remove a listener
long	storePolicyFile(java.lang.String fileName, java.io.InputStream input) Store a system policy file
long	storePolicyFileContents(java.lang.String fileName, java.lang.String fileText) Store a system policy file
default com.dtolabs.rundeck.core.authorization.RuleSetValidation<com.dtolabs.rundeck.core.authorization.providers.PolicyCollection>	validatePolicyFile(java.lang.String fname)

Method Detail

getValidator

com.dtolabs.rundeck.core.authorization.providers.BaseValidator getValidator()

addListener

default void addListener(ACLFileManagerListener listener)

Receive notification of changes

Parameters:

listener -

removeListener

default void removeListener(ACLFileManagerListener listener)

Remove a listener

Parameters:

listener -

storePolicyFile

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

Store a system policy file

Parameters:

fileName - name without path

input - input stream

Returns:

size of bytes stored

Throws:

java.io.IOException

deletePolicyFile

boolean deletePolicyFile(java.lang.String fileName)
                  throws java.io.IOException

Delete a policy file

Returns:

true if successful

Throws:

java.io.IOException

storePolicyFileContents

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

Store a system policy file

Parameters:

fileName - name without path

fileText - contents

Returns:

size of bytes stored

Throws:

java.io.IOException

getAclPolicy

AclPolicyFile getAclPolicy(java.lang.String fileName)

Retrieve a system policy

Parameters:

fileName - name without path

Returns:

definition

getPolicyFileContents

java.lang.String getPolicyFileContents(java.lang.String fileName)
                                throws java.io.IOException

Parameters:

fileName - name of policy file, without path

Returns:

text contents of the policy file

Throws:

java.io.IOException

loadPolicyFileContents

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

Load content to output stream

Parameters:

fileName - name of policy file, without path

Returns:

length of output

Throws:

java.io.IOException

existsPolicyFile

boolean existsPolicyFile(java.lang.String file)

Parameters:

file - name without path

Returns:

true if the policy file with the given name exists

validatePolicyFile

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

Throws:

java.io.IOException

listStoredPolicyFiles

java.util.List<java.lang.String> listStoredPolicyFiles()

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