org.knime.core.node.workflow

Interface CredentialsStore.CredentialsNode

All Known Implementing Classes:

VirtualSubNodeOutputNodeModel

Enclosing class:

CredentialsStore

public static interface CredentialsStore.CredentialsNode

Implemented by NodeModel classes that define credential variables. It allows the implementation to retrieve an up-to-date password from the workflow load routine (e.g. a pop-up window or some commandline flag/prompt).

Clients are usually not required to define credential-defining nodes so this interface is not considered to be API and may change in the future, specifically the dependency to WorkflowLoadHelper.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
void	doAfterLoadFromDisc(WorkflowLoadHelper loadHelper, CredentialsProvider credProvider, boolean isExecuted, boolean isInactive) Called when node is loaded from disc.
default void	onWorkfowCredentialsChanged(Collection<Credentials> workflowCredentials) Called when the workflow credentials change on a workflow.
default void	pushCredentialsFlowVariable(String name, String login, String password) Pushes a flow variable wrapping the passed credentials.

Method Detail

pushCredentialsFlowVariable

default void pushCredentialsFlowVariable(String name,
                                         String login,
                                         String password)

Pushes a flow variable wrapping the passed credentials.

Parameters:

name - Non-null identifier

login - Non-null login

password - Possibly null password.

doAfterLoadFromDisc

void doAfterLoadFromDisc(WorkflowLoadHelper loadHelper,
                         CredentialsProvider credProvider,
                         boolean isExecuted,
                         boolean isInactive)

Called when node is loaded from disc. Implementations will prompt the password by means of the workflow load helper and then pushCredentialsFlowVariable(String, String, String) it.

Parameters:

loadHelper - Non-null helper.

credProvider - The credentials provider set on the corresponding node, not null. Read-only!!

isExecuted - Whether node is executed - executed nodes do not prompt for password via the callback

isInactive - TODO

onWorkfowCredentialsChanged

default void onWorkfowCredentialsChanged(Collection<Credentials> workflowCredentials)

Called when the workflow credentials change on a workflow. Credential QF nodes in the workflow can then inherit the modified password from the workflow. Used to address AP-5974.

Method is only called on non-executed nodes; a configure call follows after all nodes in the workflow have been updated.

Parameters:

workflowCredentials - read-only list of workflow credentials.

Since:

3.3