com.redhat.rhn.domain.kickstart.cobbler

Class CobblerSnippet

java.lang.Object

com.redhat.rhn.domain.kickstart.cobbler.CobblerSnippet

All Implemented Interfaces:

java.lang.Comparable

public class CobblerSnippet
extends java.lang.Object
implements java.lang.Comparable

CobblerSnippet - Class representation of a Cobbler snippet

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
static CobblerSnippet	createOrUpdate(boolean create, java.lang.String name, java.lang.String contents, Org org) Cobbler Snippet method to be called when creating or updating the actual instance of a cobbler snippet.
void	delete() Method to allow you to delete the snippet.
boolean	equals(java.lang.Object o)
static java.io.File	getCobblerSnippetsDir() Method to return the main cobbler snippets dir (i.e.
java.lang.String	getContents() Getter for contents
java.lang.String	getDisplayName() Returns the display name used by the UI Seems like a useful method reused in different places in the UI thought this would be a good place..
java.lang.String	getDisplayPath() The path for display purposes
java.lang.String	getFragment() The actual cobbler fragment associated to this snippet
java.lang.String	getName() Returns just the name of the snippet file (same as basename) i.e.
Org	getOrg() Returns the org associated to this snippet or null if none is associated
java.io.File	getPath() Getter for name
java.lang.String	getPrefix() Returns the name of the directory hosting the snippet file (same as dirname) i.e.
static java.lang.String	getPrefixFor(Org org) Returns the name of the dir that should be hosting scripts for the snippet.
static java.io.File	getSpacewalkSnippetsDir() Method to return the base spacewalk snippets dir (i.e.
int	hashCode()
boolean	isEditable() Note: only snippets under ${spacewalk.snippets.dir}/${org.id}/${name} are editable..
static CobblerSnippet	loadEditable(java.lang.String nameIn, Org orgIn) Constructor to load a spacewalk Editable (as in Org Based) cobbler snippet..
static CobblerSnippet	loadEditableIfExists(java.lang.String nameIn, Org orgIn) Performs the same function as loadEditable, except it will return null instead of a bad snippet
static CobblerSnippet	loadReadOnly(java.io.File pathIn) Constructor load a non editable spacewalk cobbler snippets as in all the snippets that reside under /var/lib/cobbler/snippets/ except /var/lib/cobbler/snippets/spacewalk Idea here is that this list is read only and operations such as write operations cannot be performed..
static java.lang.String	makeFragment(java.lang.String path) Returns a Cobbler snippet fragment with the given path
void	rename(java.lang.String name) Renames cobbler snippet to a new name..
void	writeContents(java.lang.String contents) Basically writes the snippet contents sent to this method to the disk..

Methods inherited from class java.lang.Object

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

Method Detail

getCobblerSnippetsDir

public static java.io.File getCobblerSnippetsDir()

Method to return the main cobbler snippets dir (i.e. /var/lib/cobbler/snippets) .. Reason this is a method is because we want it to be changeable for unit tests..

Returns:

the cobbler snippets dir

getSpacewalkSnippetsDir

public static java.io.File getSpacewalkSnippetsDir()

Method to return the base spacewalk snippets dir (i.e. /var/lib/cobbler/snippets/spacewalk) .. Reason this is a method is because we want it to be changeable for unit tests..

Returns:

the spacewalk snippets dir

createOrUpdate

public static CobblerSnippet createOrUpdate(boolean create,
                                            java.lang.String name,
                                            java.lang.String contents,
                                            Org org)

Cobbler Snippet method to be called when creating or updating the actual instance of a cobbler snippet. This is in a typical case would be considered a manager layer method but its small enough to merit not creating another command/class for it.

Parameters:

create - True if we are creating a new editable snippet False updating an existing editable snippet

name - the name of the snippet.

contents - the contents of the snippet.

org - the org of the editable snippet.

Returns:

the newly Created or updated cobbler snippet..

rename

public void rename(java.lang.String name)

Renames cobbler snippet to a new name..

Parameters:

name - the name fo the new cobbler snippet

loadEditable

public static CobblerSnippet loadEditable(java.lang.String nameIn,
                                          Org orgIn)

Constructor to load a spacewalk Editable (as in Org Based) cobbler snippet.. These are snippets that reside in /var/lib/cobbler/snippets/spacewalk/${org.id}/.... Note validation errors will be raised if the name contains slashes /var/lib/cobbler/snippets/spacewalk/${org.id}/${name}

Parameters:

nameIn - the snippet name ${name} in ${spacewalk.snippets.dir}/${org.id}/${name}

orgIn - the org in ${spacewalk.snippets.dir}/${org.id}/${name}

Returns:

the cobbler snippet.

loadEditableIfExists

public static CobblerSnippet loadEditableIfExists(java.lang.String nameIn,
                                                  Org orgIn)

Performs the same function as loadEditable, except it will return null instead of a bad snippet

Parameters:

nameIn - the snippet name ${name} in ${spacewalk.snippets.dir}/${org.id}/${name}

orgIn - the org in ${spacewalk.snippets.dir}/${org.id}/${name}

Returns:

the cobbler snippet. or null if doesn't exist

loadReadOnly

public static CobblerSnippet loadReadOnly(java.io.File pathIn)

Constructor load a non editable spacewalk cobbler snippets as in all the snippets that reside under /var/lib/cobbler/snippets/ except /var/lib/cobbler/snippets/spacewalk Idea here is that this list is read only and operations such as write operations cannot be performed..

Parameters:

pathIn - /var/lib/cobbler/snippets/foo/bar

Returns:

the cobbler snippet.

getDisplayPath

public java.lang.String getDisplayPath()

The path for display purposes

Returns:

the display path

getOrg

public Org getOrg()

Returns the org associated to this snippet or null if none is associated

Returns:

the org or null

getPath

public java.io.File getPath()

Getter for name

Returns:

String to get

getContents

public java.lang.String getContents()

Getter for contents

Returns:

String to get

writeContents

public void writeContents(java.lang.String contents)

Basically writes the snippet contents sent to this method to the disk.. Note: only editable snippets can be updated, i.e. snippets under ${spacewalk.snippets.dir}/${org.id}/${name}

Parameters:

contents - the contents of the snippet

delete

public void delete()

Method to allow you to delete the snippet. Note: only editable snippets can be deleted, i.e. snippets under ${spacewalk.snippets.dir}/${org.id}/${name}

isEditable

public boolean isEditable()

Note: only snippets under ${spacewalk.snippets.dir}/${org.id}/${name} are editable..

Returns:

true if this cobbler snippet is editable..

getName

public java.lang.String getName()

Returns just the name of the snippet file (same as basename) i.e. returns ${name} in ${spacewalk.snippets.dir}/${org.id}/${name}

Returns:

the base name of the snippet file

getPrefix

public java.lang.String getPrefix()

Returns the name of the directory hosting the snippet file (same as dirname) i.e. returns ${spacewalk.snippets.dir}/${org.id} in ${spacewalk.snippets.dir}/${org.id}/${name}

Returns:

the name of the directory hosting the snippet file

getDisplayName

public java.lang.String getDisplayName()

Returns the display name used by the UI Seems like a useful method reused in different places in the UI thought this would be a good place..

Returns:

the display name

getFragment

public java.lang.String getFragment()

The actual cobbler fragment associated to this snippet

Returns:

cobbler code fragment

makeFragment

public static java.lang.String makeFragment(java.lang.String path)

Returns a Cobbler snippet fragment with the given path

Parameters:

path - the path to make a snippet of

Returns:

the snippet fragment

getPrefixFor

public static java.lang.String getPrefixFor(Org org)

Returns the name of the dir that should be hosting scripts for the snippet. This is useful for example while creating snippets.

Parameters:

org - the org hosting the snippet, or null if its a common org

Returns:

the name of the directory that should host the snippet file

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable