com.sshtools.config.file.entry

Class MatchEntry.MatchEntryBuilder

java.lang.Object

com.sshtools.config.file.entry.Entry.AbstractEntryBuilder<MatchEntry.MatchEntryBuilder>

com.sshtools.config.file.entry.MatchEntry.MatchEntryBuilder

All Implemented Interfaces:

EntryBuilder<MatchEntry.MatchEntryBuilder,SshdConfigFile.SshdConfigFileBuilder>

Enclosing class:

MatchEntry

public static class MatchEntry.MatchEntryBuilder
extends Entry.AbstractEntryBuilder<MatchEntry.MatchEntryBuilder>
implements EntryBuilder<MatchEntry.MatchEntryBuilder,SshdConfigFile.SshdConfigFileBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class com.sshtools.config.file.entry.Entry.AbstractEntryBuilder

Entry.AbstractEntryBuilder.Result<T>

Field Summary

Fields inherited from class com.sshtools.config.file.entry.Entry.AbstractEntryBuilder

cursor, file, pointer

Constructor Summary

Constructors

Constructor and Description
MatchEntryBuilder(SshdConfigFile.SshdConfigFileBuilder parentBuilder, SshdConfigFile file, SshdConfigFileCursor cursor)
MatchEntryBuilder(SshdConfigFile.SshdConfigFileBuilder parentBuilder, SshdConfigFile file, SshdConfigFileCursor cursor, MatchEntry managedInstance)

Method Summary

Modifier and Type	Method and Description
MatchEntry.MatchEntryBuilder	addAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	addAddressCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addGroupCriteria(String value)
MatchEntry.MatchEntryBuilder	addGroupCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addHostCriteria(String value)
MatchEntry.MatchEntryBuilder	addHostCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addLocalAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	addLocalAddressCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addLocalPortCriteria(String value)
MatchEntry.MatchEntryBuilder	addLocalPortCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addMatchCriteriaComment(FileEntryType.CommentEntry commentEntry) To add comment to a Match Criteria.
MatchEntry.MatchEntryBuilder	addRDomainCriteria(String value)
MatchEntry.MatchEntryBuilder	addRDomainCriteria(String[] values)
MatchEntry.MatchEntryBuilder	addUserCriteria(String value)
MatchEntry.MatchEntryBuilder	addUserCriteria(String[] values)
MatchEntry.MatchEntryBuilder	deleteAddressCriteria()
MatchEntry.MatchEntryBuilder	deleteGroupCriteria()
MatchEntry.MatchEntryBuilder	deleteHostCriteria()
MatchEntry.MatchEntryBuilder	deleteLocalAddressCriteria()
MatchEntry.MatchEntryBuilder	deleteLocalPortCriteria()
MatchEntry.MatchEntryBuilder	deleteRDomainCriteria()
MatchEntry.MatchEntryBuilder	deleteUserCriteria()
SshdConfigFile.SshdConfigFileBuilder	end()
protected Entry	getManagedInstance()
MatchEntry.MatchEntryBuilder	parse(String[] matchValueSplit)
MatchEntry.MatchEntryBuilder	pushAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	pushGroupCriteria(String value)
MatchEntry.MatchEntryBuilder	pushHostCriteria(String value)
MatchEntry.MatchEntryBuilder	pushLocalAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	pushLocalPortCriteria(String value)
MatchEntry.MatchEntryBuilder	pushRDomainCriteria(String value)
MatchEntry.MatchEntryBuilder	pushUserCriteria(String value)
MatchEntry.MatchEntryBuilder	updateAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	updateGroupCriteria(String value)
MatchEntry.MatchEntryBuilder	updateHostCriteria(String value)
MatchEntry.MatchEntryBuilder	updateLocalAddressCriteria(String value)
MatchEntry.MatchEntryBuilder	updateLocalPortCriteria(String value)
MatchEntry.MatchEntryBuilder	updateRDomainCriteria(String value)
MatchEntry.MatchEntryBuilder	updateUserCriteria(String value)

Methods inherited from class com.sshtools.config.file.entry.Entry.AbstractEntryBuilder

addBeginingComment, addComment, addCommentForEntry, addCommentForEntry, addEntry, appendEntry, cursor, deleteEntry, entryMatches, entryMatches, findEntry, findEntry, findEntryAtIndex, findEntryIndex, findEntryIndex, findEntryToEdit, resetPointer, updateEntry

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.config.file.EntryBuilder

cursor

Constructor Detail

MatchEntryBuilder

public MatchEntryBuilder(SshdConfigFile.SshdConfigFileBuilder parentBuilder,
                         SshdConfigFile file,
                         SshdConfigFileCursor cursor)

MatchEntryBuilder

public MatchEntryBuilder(SshdConfigFile.SshdConfigFileBuilder parentBuilder,
                         SshdConfigFile file,
                         SshdConfigFileCursor cursor,
                         MatchEntry managedInstance)

Method Detail

addMatchCriteriaComment

public MatchEntry.MatchEntryBuilder addMatchCriteriaComment(FileEntryType.CommentEntry commentEntry)

To add comment to a Match Criteria.
Note: This will only add comments to file on write. On read there will be no such list of comments available. There is no definitive way to distinguish between end of Global section and start of Match section comments.

 NoneEnabled no
 # Comment (X) HPNBufferSize 2048
 #Comment 1
 #Comment 2
 Match .......
 

There is no way to tell Comment 1 and 2 belong to Match or the Global Section. Comment could be eligible entry as X above.
On write the comments added would be written right before match criteria entry.

Parameters:

commentEntry -

Returns:

addUserCriteria

public MatchEntry.MatchEntryBuilder addUserCriteria(String[] values)

addUserCriteria

public MatchEntry.MatchEntryBuilder addUserCriteria(String value)

pushUserCriteria

public MatchEntry.MatchEntryBuilder pushUserCriteria(String value)

updateUserCriteria

public MatchEntry.MatchEntryBuilder updateUserCriteria(String value)

deleteUserCriteria

public MatchEntry.MatchEntryBuilder deleteUserCriteria()

addGroupCriteria

public MatchEntry.MatchEntryBuilder addGroupCriteria(String[] values)

addGroupCriteria

public MatchEntry.MatchEntryBuilder addGroupCriteria(String value)

pushGroupCriteria

public MatchEntry.MatchEntryBuilder pushGroupCriteria(String value)

updateGroupCriteria

public MatchEntry.MatchEntryBuilder updateGroupCriteria(String value)

deleteGroupCriteria

public MatchEntry.MatchEntryBuilder deleteGroupCriteria()

addHostCriteria

public MatchEntry.MatchEntryBuilder addHostCriteria(String[] values)

addHostCriteria

public MatchEntry.MatchEntryBuilder addHostCriteria(String value)

pushHostCriteria

public MatchEntry.MatchEntryBuilder pushHostCriteria(String value)

updateHostCriteria

public MatchEntry.MatchEntryBuilder updateHostCriteria(String value)

deleteHostCriteria

public MatchEntry.MatchEntryBuilder deleteHostCriteria()

addLocalPortCriteria

public MatchEntry.MatchEntryBuilder addLocalPortCriteria(String[] values)

addLocalPortCriteria

public MatchEntry.MatchEntryBuilder addLocalPortCriteria(String value)

pushLocalPortCriteria

public MatchEntry.MatchEntryBuilder pushLocalPortCriteria(String value)

updateLocalPortCriteria

public MatchEntry.MatchEntryBuilder updateLocalPortCriteria(String value)

deleteLocalPortCriteria

public MatchEntry.MatchEntryBuilder deleteLocalPortCriteria()

addLocalAddressCriteria

public MatchEntry.MatchEntryBuilder addLocalAddressCriteria(String[] values)

addLocalAddressCriteria

public MatchEntry.MatchEntryBuilder addLocalAddressCriteria(String value)

pushLocalAddressCriteria

public MatchEntry.MatchEntryBuilder pushLocalAddressCriteria(String value)

updateLocalAddressCriteria

public MatchEntry.MatchEntryBuilder updateLocalAddressCriteria(String value)

deleteLocalAddressCriteria

public MatchEntry.MatchEntryBuilder deleteLocalAddressCriteria()

addAddressCriteria

public MatchEntry.MatchEntryBuilder addAddressCriteria(String[] values)

addAddressCriteria

public MatchEntry.MatchEntryBuilder addAddressCriteria(String value)

pushAddressCriteria

public MatchEntry.MatchEntryBuilder pushAddressCriteria(String value)

updateAddressCriteria

public MatchEntry.MatchEntryBuilder updateAddressCriteria(String value)

deleteAddressCriteria

public MatchEntry.MatchEntryBuilder deleteAddressCriteria()

addRDomainCriteria

public MatchEntry.MatchEntryBuilder addRDomainCriteria(String[] values)

addRDomainCriteria

public MatchEntry.MatchEntryBuilder addRDomainCriteria(String value)

pushRDomainCriteria

public MatchEntry.MatchEntryBuilder pushRDomainCriteria(String value)

updateRDomainCriteria

public MatchEntry.MatchEntryBuilder updateRDomainCriteria(String value)

deleteRDomainCriteria

public MatchEntry.MatchEntryBuilder deleteRDomainCriteria()

parse

public MatchEntry.MatchEntryBuilder parse(String[] matchValueSplit)

end

public SshdConfigFile.SshdConfigFileBuilder end()

Specified by:

end in interface EntryBuilder<MatchEntry.MatchEntryBuilder,SshdConfigFile.SshdConfigFileBuilder>

getManagedInstance

protected Entry getManagedInstance()

Specified by:

getManagedInstance in class Entry.AbstractEntryBuilder<MatchEntry.MatchEntryBuilder>