ScmWebEditorCommitAction (ScmWebEditor UI web 0.7 API)

java.lang.Object
- com.opensymphony.xwork2.ActionSupport
- - org.nuiton.web.struts2.BaseAction
  - - org.nuiton.scmwebeditor.uiweb.actions.AbstractScmWebEditorAction
    - - org.nuiton.scmwebeditor.uiweb.actions.ScmWebEditorCommitAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, Serializable, org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.ServletResponseAware

Direct Known Subclasses:

SaveAction
```
public class ScmWebEditorCommitAction
extends AbstractScmWebEditorAction
implements org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.ServletResponseAware
```
Commits all the changes to the remote repository

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`address` the repository's address
`protected boolean`	`badLogin` equals true if there has been a problem during the authentication process
`protected String`	`commitMessage` a message to describe the commit
`protected boolean`	`commitOnly` equals true if only a commit is requested, without a push
`protected String`	`diff` the differences between the current content and the last revision's content
`static String`	`FILE_MODIFY`
`protected boolean`	`force` equals true to force the commit
`protected String`	`format` the edited file's format
`protected String`	`headCommiter` the name of the person who made the last commit
`protected String`	`lastText` the last revision's file content
`protected String`	`mimeType` the file's MIME type
`protected String`	`newText` the new file content
`protected String`	`numRevision` the number of the current revision
`protected String`	`origText` the old file content
`protected String`	`projectUrl` the URL to the root of the repository
`protected String`	`pw` the password to use to connect to the repository
`protected javax.servlet.http.HttpServletRequest`	`request` the HTTP request sent to the server
`protected javax.servlet.http.HttpServletResponse`	`response` the HTTP response to send to the client
`protected boolean`	`saveCookie` equals true if the authentication information has to be saved in a cookie
`protected String`	`username` the username to use to connect to the repository

Fields inherited from class com.opensymphony.xwork2.ActionSupport
LOG

Fields inherited from interface com.opensymphony.xwork2.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description

ScmWebEditorCommitAction()

Constructors
Constructor and Description
`ScmWebEditorCommitAction()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`execute()` Execution of the commit action
`String`	`getAddress()`
`String`	`getCommitMessage()`
`String`	`getDiff()`
`boolean`	`getForce()`
`String`	`getFormat()`
`String`	`getHeadCommiter()`
`String`	`getLastText()`
`String`	`getMimeType()`
`String`	`getNewText()`
`String`	`getNumRevision()`
`String`	`getOrigText()`
`String`	`getParameterAddress()`
`String`	`getProjectUrl()`
`String`	`getPw()`
`javax.servlet.http.HttpServletRequest`	`getRequest()`
`String`	`getUsername()`
`boolean`	`isBadLogin()`
`boolean`	`isCommitOnly()`
`protected boolean`	`isRstValid(String rstContent)` Tells whether a RST file has a valid syntax
`boolean`	`isSaveCookie()`
`void`	`setAddress(String address)`
`void`	`setBadLogin(boolean badLogin)`
`void`	`setCommitMessage(String commitMessage)`
`void`	`setCommitOnly(boolean commitOnly)`
`void`	`setDiff(String diff)`
`void`	`setForce(boolean force)`
`void`	`setFormat(String format)`
`void`	`setHeadCommiter(String headCommiter)`
`void`	`setLastText(String lastText)`
`void`	`setMimeType(String mimeType)`
`void`	`setNewText(String newText)`
`void`	`setNumRevision(String numRevision)`
`void`	`setOrigText(String origText)`
`void`	`setProjectUrl(String projectUrl)`
`void`	`setPw(String pw)`
`void`	`setSaveCookie(boolean saveCookie)`
`void`	`setServletRequest(javax.servlet.http.HttpServletRequest request)`
`void`	`setServletResponse(javax.servlet.http.HttpServletResponse response)`
`void`	`setUsername(String username)`

Methods inherited from class org.nuiton.scmwebeditor.uiweb.actions.AbstractScmWebEditorAction
convertToUnicode, getCodepageDetector, getMimeType, getMimeType, getMimeTypes, getPassword, getScmSession, getScmType, getSweVersion, getUsername, getUsernamePwFromSession, loadProperties, loadProperties, setScmType

Methods inherited from class org.nuiton.web.struts2.BaseAction
t

Methods inherited from class com.opensymphony.xwork2.ActionSupport
addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- FILE_MODIFY
```
public static final String FILE_MODIFY
```
  See Also:
  Constant Field Values
- newText
```
protected String newText
```
  the new file content
- commitMessage
```
protected String commitMessage
```
  a message to describe the commit
- origText
```
protected String origText
```
  the old file content
- username
```
protected String username
```
  the username to use to connect to the repository
- pw
```
protected String pw
```
  the password to use to connect to the repository
- address
```
protected String address
```
  the repository's address
- lastText
```
protected String lastText
```
  the last revision's file content
- format
```
protected String format
```
  the edited file's format
- projectUrl
```
protected String projectUrl
```
  the URL to the root of the repository
- diff
```
protected String diff
```
  the differences between the current content and the last revision's content
- headCommiter
```
protected String headCommiter
```
  the name of the person who made the last commit
- mimeType
```
protected String mimeType
```
  the file's MIME type
- force
```
protected boolean force
```
  equals true to force the commit
- saveCookie
```
protected boolean saveCookie
```
  equals true if the authentication information has to be saved in a cookie
- badLogin
```
protected boolean badLogin
```
  equals true if there has been a problem during the authentication process
- numRevision
```
protected String numRevision
```
  the number of the current revision
- commitOnly
```
protected boolean commitOnly
```
  equals true if only a commit is requested, without a push
- request
```
protected transient javax.servlet.http.HttpServletRequest request
```
  the HTTP request sent to the server
- response
```
protected transient javax.servlet.http.HttpServletResponse response
```
  the HTTP response to send to the client

Constructor Detail
- ScmWebEditorCommitAction
```
public ScmWebEditorCommitAction()
```

Method Detail

getCommitMessage
```
public String getCommitMessage()
```

setCommitMessage

public void setCommitMessage(String commitMessage)

getNewText
```
public String getNewText()
```

setNewText

public void setNewText(String newText)

getFormat
```
public String getFormat()
```

setFormat
```
public void setFormat(String format)
```

getOrigText
```
public String getOrigText()
```

setOrigText

public void setOrigText(String origText)

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String username)

getPw
```
public String getPw()
```

setPw
```
public void setPw(String pw)
```

getAddress
```
public String getAddress()
```

setAddress

public void setAddress(String address)

getLastText
```
public String getLastText()
```

setLastText

public void setLastText(String lastText)

getProjectUrl
```
public String getProjectUrl()
```

setProjectUrl

public void setProjectUrl(String projectUrl)

getNumRevision
```
public String getNumRevision()
```

setNumRevision

public void setNumRevision(String numRevision)

getDiff
```
public String getDiff()
```

setDiff
```
public void setDiff(String diff)
```

getHeadCommiter
```
public String getHeadCommiter()
```

setHeadCommiter

public void setHeadCommiter(String headCommiter)

isSaveCookie
```
public boolean isSaveCookie()
```

setSaveCookie

public void setSaveCookie(boolean saveCookie)

getMimeType
```
public String getMimeType()
```

setMimeType

public void setMimeType(String mimeType)

getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
Overrides:

getRequest in class AbstractScmWebEditorAction

getForce
```
public boolean getForce()
```

setForce
```
public void setForce(boolean force)
```

getParameterAddress
```
public String getParameterAddress()
```

isBadLogin
```
public boolean isBadLogin()
```

setBadLogin

public void setBadLogin(boolean badLogin)

isCommitOnly
```
public boolean isCommitOnly()
```

setCommitOnly

public void setCommitOnly(boolean commitOnly)

isRstValid
```
protected boolean isRstValid(String rstContent)
```
Tells whether a RST file has a valid syntax

Parameters:
rstContent - the text to check

Returns:
true if the syntax is valid

execute
```
public String execute()
```
Execution of the commit action

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Returns:
a code interpreted in the file struts.xml

setServletRequest
```
public void setServletRequest(javax.servlet.http.HttpServletRequest request)
```
Specified by:

setServletRequest in interface org.apache.struts2.interceptor.ServletRequestAware

Overrides:

setServletRequest in class AbstractScmWebEditorAction

setServletResponse
```
public void setServletResponse(javax.servlet.http.HttpServletResponse response)
```
Specified by:

setServletResponse in interface org.apache.struts2.interceptor.ServletResponseAware

Class ScmWebEditorCommitAction

Field Summary

Fields inherited from class org.nuiton.scmwebeditor.uiweb.actions.AbstractScmWebEditorAction

Fields inherited from class com.opensymphony.xwork2.ActionSupport

Fields inherited from interface com.opensymphony.xwork2.Action

Constructor Summary

Method Summary

Methods inherited from class org.nuiton.scmwebeditor.uiweb.actions.AbstractScmWebEditorAction

Methods inherited from class org.nuiton.web.struts2.BaseAction

Methods inherited from class com.opensymphony.xwork2.ActionSupport

Methods inherited from class java.lang.Object

Field Detail

FILE_MODIFY

newText

commitMessage

origText

username

pw

address

lastText

format

projectUrl

diff

headCommiter

mimeType

force

saveCookie

badLogin

numRevision

commitOnly

request

response

Constructor Detail

ScmWebEditorCommitAction

Method Detail

getCommitMessage

setCommitMessage

getNewText

setNewText

getFormat

setFormat

getOrigText

setOrigText

getUsername

setUsername

getPw

setPw

getAddress

setAddress

getLastText

setLastText

getProjectUrl

setProjectUrl

getNumRevision

setNumRevision

getDiff

setDiff

getHeadCommiter

setHeadCommiter

isSaveCookie

setSaveCookie

getMimeType

setMimeType

getRequest

getForce

setForce

getParameterAddress

isBadLogin

setBadLogin

isCommitOnly

setCommitOnly

isRstValid

execute

setServletRequest

setServletResponse