Package hudson.plugins.jobConfigHistory

Class ComputerConfigHistoryAction

java.lang.Object
hudson.plugins.jobConfigHistory.JobConfigHistoryBaseAction
hudson.plugins.jobConfigHistory.ComputerConfigHistoryAction
All Implemented Interfaces:
Action, ModelObject
@ExportedBean(defaultVisibility=-1) public class ComputerConfigHistoryAction extends JobConfigHistoryBaseAction
Author:
Lucie Votypkova

  • Constructor Details

    • ComputerConfigHistoryAction

      public ComputerConfigHistoryAction(Slave agent)
      Standard constructor using instance.
      Parameters:
      agent - agent.

  • Method Details

    • getDisplayName

      public final String getDisplayName()
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
      Overrides:
      getDisplayName in class JobConfigHistoryBaseAction

    • getUrlName

      public String getUrlName()
      Specified by:
      getUrlName in interface Action
      Overrides:
      getUrlName in class JobConfigHistoryBaseAction

    • getSlave

      @Deprecated public Slave getSlave()
      Deprecated.
      Use getAgent() instead. This method is subject to removal in future releases, to comply with Jenkins' terminology updates.
      Returns the agent.
      Returns:
      the agent.

    • getAgent

      public Slave getAgent()
      Returns the agent.
      Returns:
      the agent.

    • getAccessControlledObject

      protected AccessControlled getAccessControlledObject()
      Description copied from class: JobConfigHistoryBaseAction
      Returns the object for which we want to provide access control.
      Specified by:
      getAccessControlledObject in class JobConfigHistoryBaseAction
      Returns:
      the access controlled object.

    • checkConfigurePermission

      protected void checkConfigurePermission()
      Description copied from class: JobConfigHistoryBaseAction
      See whether the current user may read configurations in the object returned by JobConfigHistoryBaseAction.getAccessControlledObject().
      Specified by:
      checkConfigurePermission in class JobConfigHistoryBaseAction

    • checkDeleteEntryPermission

      protected void checkDeleteEntryPermission()
      Specified by:
      checkDeleteEntryPermission in class JobConfigHistoryBaseAction

    • hasAdminPermission

      public boolean hasAdminPermission()
      Specified by:
      hasAdminPermission in class JobConfigHistoryBaseAction

    • hasDeleteEntryPermission

      public boolean hasDeleteEntryPermission()
      Specified by:
      hasDeleteEntryPermission in class JobConfigHistoryBaseAction

    • hasConfigurePermission

      public boolean hasConfigurePermission()
      Description copied from class: JobConfigHistoryBaseAction
      Returns whether the current user may read configurations in the object returned by JobConfigHistoryBaseAction.getAccessControlledObject().
      Specified by:
      hasConfigurePermission in class JobConfigHistoryBaseAction
      Returns:
      true if the current user may read configurations.

    • getRevisionAmount

      public int getRevisionAmount()
      Specified by:
      getRevisionAmount in class JobConfigHistoryBaseAction
      Returns:
      the amount of revisions existing for the given request (not page-dependant).

    • getIconFileName

      public final String getIconFileName()

    • getSlaveConfigs

      @Deprecated public final List<ConfigInfo> getSlaveConfigs()
      Deprecated.
      Use getAgentConfigs() instead. This method is subject to removal in future releases, to comply with Jenkins' terminology updates.
      Returns the configuration history entries for one Slave.
      Returns:
      history list for one Slave.

    • getAgentConfigs

      public final List<ConfigInfo> getAgentConfigs()
      Returns the configuration history entries for one Slave.
      Returns:
      history list for one Slave.

    • hasReadExtensionPermission

      public boolean hasReadExtensionPermission()

    • getAgentConfigs

      public final List<ConfigInfo> getAgentConfigs(int from, int to)
      Calculates a list containing the .subList(from, to) of the newest-first list of job config revision entries. Does not read the history.xmls unless it is inevitable.
      Parameters:
      from - the first revision to display
      to - the first revision not to display anymore
      Returns:
      a list equivalent to getJobConfigs().subList(from, to), but more efficiently calculated.

    • getSlaveConfigsREST

      @Deprecated @Exported(name="jobConfigHistory", visibility=1) public final List<ConfigInfo> getSlaveConfigsREST() throws IOException
      Deprecated.
      Use getAgentConfigs() instead. This method is subject to removal in future releases, to comply with Jenkins' terminology updates.
      Returns the configuration history entries for one Slave for the REST API.
      Returns:
      history list for one Slave, or an empty list if not authorized.
      Throws:
      IOException - if JobConfigHistoryConsts.HISTORY_FILE might not be read or the path might not be urlencoded.

    • getAgentConfigsREST

      @Exported(name="jobConfigHistory", visibility=1) public final List<ConfigInfo> getAgentConfigsREST() throws IOException
      Returns the configuration history entries for one Slave for the REST API.
      Returns:
      history list for one Slave, or an empty list if not authorized.
      Throws:
      IOException - if JobConfigHistoryConsts.HISTORY_FILE might not be read or the path might not be urlencoded.

    • getTimestamp

      public final String getTimestamp(int timestampNumber)
      Used in the Difference jelly only. Returns one of the two timestamps that have been passed to the Difference page as parameter. timestampNumber must be 1 or 2.
      Parameters:
      timestampNumber - 1 for timestamp1 and 2 for timestamp2
      Returns:
      the timestamp as String.

    • getUser

      public final String getUser(int timestampNumber)
      Used in the Difference jelly only. Returns the user that made the change in one of the Files shown in the Difference view(A or B). timestampNumber decides between File A and File B.
      Parameters:
      timestampNumber - 1 for File A and 2 for File B
      Returns:
      the user as String.

    • getUserID

      public final String getUserID(int timestamp)

    • getChangeReasonComment

      public final String getChangeReasonComment(int timestamp)

    • hasChangeReasonComment

      public final boolean hasChangeReasonComment(int timestamp)

    • getOperation

      public final String getOperation(int timestampNumber)
      Used in the Difference jelly only. Returns the operation made on one of the two Files A and B. timestampNumber decides which file exactly.
      Parameters:
      timestampNumber - 1 for File A, 2 for File B
      Returns:
      the operation as String.

    • getNextTimestamp

      public final String getNextTimestamp(int timestampNumber)
      Used in the Difference jelly only. Returns the next timestamp of the next entry of the two Files A and B. timestampNumber decides which file exactly.
      Parameters:
      timestampNumber - 1 for File A, 2 for File B
      Returns:
      the timestamp of the next entry as String.

    • getPrevTimestamp

      public final String getPrevTimestamp(int timestampNumber)
      Used in the Difference jelly only. Returns the previous timestamp of the next entry of the two Files A and B. timestampNumber decides which file exactly.
      Parameters:
      timestampNumber - 1 for File A, 2 for File B
      Returns:
      the timestamp of the previous entry as String.

    • getFile

      public final String getFile() throws IOException
      Returns getOldConfigXml(String) as String.
      Returns:
      content of the config.xml found in directory given by the request parameter file.
      Throws:
      IOException - if the config file could not be read or converted to an xml string.

    • getLines

      public final List<SideBySideView.Line> getLines(boolean hideVersionDiffs) throws IOException
      Specified by:
      getLines in class JobConfigHistoryBaseAction
      Throws:
      IOException

    • checkXmlSyntax

      public XmlSyntaxChecker.Answer checkXmlSyntax(String timestamp)

    • doRestore

      @POST public final void doRestore(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Action when 'restore' button is pressed: Replace current config file by older version.
      Parameters:
      req - Incoming StaplerRequest2
      rsp - Outgoing StaplerResponse2
      Throws:
      IOException - If something goes wrong

    • doDeleteRevision

      @POST public final void doDeleteRevision(org.kohsuke.stapler.StaplerRequest2 req)

    • revisionEqualsCurrent

      public boolean revisionEqualsCurrent(String timestamp)

    • doToggleShowHideVersionDiffs

      public final void doToggleShowHideVersionDiffs(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Action when 'Show / hide Version Changes' button in showDiffFiles.jelly is pressed: Reloads the page with "showVersionDiffs" parameter inversed.
      Parameters:
      req - StaplerRequest2 created by pressing the button
      rsp - Outgoing StaplerResponse2
      Throws:
      IOException - If XML file can't be read

    • getApi

      public Api getApi()

    • getLeadingWhitespace

      public int getLeadingWhitespace(String str)