|
| |
|
| java.lang.Object
 org.openharmonise.commons.xml.XMLDocument
org.openharmonise.rm.publishing.State
| State | | public class State extends XMLDocument (Code) | | This class provides an XML representation of a context with the process of
publishing content within the Harmonise framework. Extending XMLDocument, it is
generally a XML representation of the HTTP query string which the Harmonise
servlet receives.
author:
Michael Bell
version:
$Revision: 1.2 $ |
| ATTRIB_STATE_ID | | final public static String ATTRIB_STATE_ID(Code) | | |
| PNAME_DEFAULT_PAGE | | final protected static String PNAME_DEFAULT_PAGE(Code) | | |
| m_bIsPopulated | | protected boolean m_bIsPopulated(Code) | | |
| addFileContents | | public void addFileContents(File fileContent)(Code) | | Adds the file as extra contents to this representation of the state.
Parameters:
fileContent - |
| addHttpParams | | protected void addHttpParams(StringBuffer sUrl, StringBuffer sCurrentFragment, Element el)(Code) | | Adds HTTP parameters to a URL, recurses to grow the URL.
Parameters:
sUrl - The URL that is being built
Parameters:
sCurrentFragment - The current context
Parameters:
el - The Element to start at |
| addStringContents | | public void addStringContents(String sContent)(Code) | | Adds sContent as extra content to this state.
Parameters:
stringContent - |
| encodeAsHttpParams | | public String encodeAsHttpParams()(Code) | | Returns a String that is this state converted to a list of HTTP params.
The parameters |
| findElement | | public Element findElement(Element el)(Code) | | Finds element in state which matches the given element
Parameters:
el - Element to match in state
Parameters:
state - XML representation of state
exception:
Exception - Matching Element found in state |
| findElements | | public List findElements(Element el)(Code) | | Finds elements in state which matches the given element.
Parameters:
el - Element to match in state
Parameters:
state - XML representation of state
exception:
Exception - Matching Element found in state |
| getCurrentPageId | | public int getCurrentPageId() throws Exception(Code) | | Returns the current Webpage id found in the state.
Parameters:
state - XML representation of the state
exception:
Exception - Current Webpage id |
| getFile | | public File getFile()(Code) | | Returns the File contents of this state.
|
| getHeaders | | public Map getHeaders()(Code) | | Returns the headers included in the HTTP request.
|
| getLoggedInUser | | public User getLoggedInUser()(Code) | | Finds and returns the logged-in User found from Session in the state.
Parameters:
state - XML representation of the state
exception:
Exception - User found in the state |
| getLoggedInUserProfile | | public Profile getLoggedInUserProfile()(Code) | | Finds logged in User from Session in the state and returns their Profile.
Parameters:
state - XML state representation
exception:
Exception - Profile of current logged in user |
| getPageId | | public int getPageId()(Code) | | Returns the page id from state.
|
| getRemoteAddress | | public String getRemoteAddress()(Code) | | Returns the remote address associated with the HTTP request.
|
| getSessionId | | public String getSessionId()(Code) | | Returns the session id from state.
|
| getStringContent | | public String getStringContent()(Code) | | Returns the String contents of this state.
|
| resolveRelativePath | | public String resolveRelativePath(String sClassName, String sPath) throws StateException(Code) | | Resolves a relative path to an absolute one. Only copes
with relative tokens at the beginning of a path.
Parameters:
sClassName - The tag name for the class that the path is in the context of
Parameters:
sPath - The path An absolute version of the path
throws:
Exception - |
| setLoggedInUser | | public void setLoggedInUser(User usr)(Code) | | Adds a user to this state representation.
Parameters:
usr - |
| setSessionId | | public void setSessionId(String sessionId)(Code) | | Sets the session id associated to this object.
Parameters:
sessionId - the session id |
| Methods inherited from org.openharmonise.commons.xml.XMLDocument | public Node appendChild(Node arg0) throws DOMException(Code)(Java Doc)
public Node cloneNode(boolean arg0)(Code)(Java Doc)
public static boolean compareElement(Element origEl, Element compEl)(Code)(Java Doc)
public void copyChildren(Element parent_destination, Element parent_source)(Code)(Java Doc)
public void copyChildren(Element parent_destination, Element parent_source, Vector ignoreTags)(Code)(Java Doc)
public Node copyNode(Node originalEl)(Code)(Java Doc)
public Attr createAttribute(String arg0) throws DOMException(Code)(Java Doc)
public Attr createAttributeNS(String arg0, String arg1) throws DOMException(Code)(Java Doc)
public CDATASection createCDATASection(String arg0) throws DOMException(Code)(Java Doc)
public Comment createComment(String arg0)(Code)(Java Doc)
public DocumentFragment createDocumentFragment()(Code)(Java Doc)
public Element createElement(String arg0) throws DOMException(Code)(Java Doc)
public Element createElementNS(String arg0, String arg1) throws DOMException(Code)(Java Doc)
public EntityReference createEntityReference(String arg0) throws DOMException(Code)(Java Doc)
public ProcessingInstruction createProcessingInstruction(String arg0, String arg1) throws DOMException(Code)(Java Doc)
public Text createTextNode(String arg0)(Code)(Java Doc)
public static String elementInfo(Element element)(Code)(Java Doc)
public boolean equals(Object arg0)(Code)(Java Doc)
public static Element findElement(Element sourceEl, Element toFindEl)(Code)(Java Doc)
public NamedNodeMap getAttributes()(Code)(Java Doc)
public NodeList getChildNodes()(Code)(Java Doc)
public static String getChildTextNodeValue(Element xmlElement)(Code)(Java Doc)
public DocumentType getDoctype()(Code)(Java Doc)
public Element getDocumentElement()(Code)(Java Doc)
public Element getElementById(String arg0)(Code)(Java Doc)
public NodeList getElementsByTagName(String arg0)(Code)(Java Doc)
public NodeList getElementsByTagNameNS(String arg0, String arg1)(Code)(Java Doc)
public Node getFirstChild()(Code)(Java Doc)
public DOMImplementation getImplementation()(Code)(Java Doc)
public Node getLastChild()(Code)(Java Doc)
public String getLocalName()(Code)(Java Doc)
public String getNamespaceURI()(Code)(Java Doc)
public Node getNextSibling()(Code)(Java Doc)
public String getNodeName()(Code)(Java Doc)
public short getNodeType()(Code)(Java Doc)
public String getNodeValue() throws DOMException(Code)(Java Doc)
public Document getOwnerDocument()(Code)(Java Doc)
public Node getParentNode()(Code)(Java Doc)
public String getPrefix()(Code)(Java Doc)
public Node getPreviousSibling()(Code)(Java Doc)
public static org.w3c.dom.Document getXMLDocumentFromString(String sXML) throws SAXException, IOException, ParserConfigurationException, FactoryConfigurationError(Code)(Java Doc)
public boolean hasAttributes()(Code)(Java Doc)
public boolean hasChildNodes()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public Node importNode(Node arg0, boolean arg1) throws DOMException(Code)(Java Doc)
public Node insertBefore(Node arg0, Node arg1) throws DOMException(Code)(Java Doc)
public boolean isSupported(String arg0, String arg1)(Code)(Java Doc)
public void normalize()(Code)(Java Doc)
public static String printNode(Node node)(Code)(Java Doc)
public Node removeChild(Node arg0) throws DOMException(Code)(Java Doc)
public Node replaceChild(Node arg0, Node arg1) throws DOMException(Code)(Java Doc)
public void setNodeValue(String arg0) throws DOMException(Code)(Java Doc)
public void setPrefix(String arg0) throws DOMException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|
|