Java Doc for SessionContext.java in  » Web-Framework » jWic » de » jwic » base » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » jWic » de.jwic.base   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    de.jwic.base.SessionContext SessionContext public class SessionContext implements IControlContainer,Serializable(Code) Holds the configuration data for a specific application session. The lifecycle of the SessionContext is managed by the JWicRuntime. author:    Florian Lippisch Field Summary final static  int AFTER_DESERIALIZATION      final static  int BEFORE_SERIALIZATION      final public static  String PROP_APPID      final public static  String PROP_AUTHENTICATION      final public static  String PROP_CONTROL      final public static  String PROP_NAME      final public static  String PROP_SERIALIZABLE      final public static  String PROP_SINGLESESSION      final static  int SESSION_REUSED      final static  int SESSION_STARTED      final static  int SESSION_STOPPED      final public static  int STATE_DESTROYED      final public static  int STATE_NORMAL      final public static  int STATE_STORED      Constructor Summary   SessionContext(IApplicationSetup appSetup, Locale locale)      Creates a blank new SessionContext. Method Summary public  void addLayer(String layerID, Control control)      Add a link to a control. public  void addSessionListener(SessionListener listener)      Adds a SessionListener to this SessionContext. public  void adopt(Control control, String name)      public  void clearRedirect()      Stop the frame from redirecting to a previous specified URL. public  void destroy()      Remove all controls in the context and destroy them. public  void exit()      Exit the session and clean up all controls.  void fireEvent(SessionEvent event, int method)      Fire the specified event/method. public  IActionController getActionController()      public  IApplication getApplication()      public  IApplicationSetup getApplicationSetup()      Returns the IApplicationSetup this session is based upon. public  java.lang.String getCallBackURL()      Get the URL that will display the frame/session in the current state. public  String getClientId()      public  Control getControl(String ctrlName)      Returns the FrameControl specified by its name. public  Control getControlById(String ctrlID)      Get a control by its control ID. public  Control getControlByLayerID(String layerID)      Returns the FrameControl specified by a link. public  Iterator getControls()      Returns an Iterator for all FrameControl objects. public  String getExitURL()      Returns the URL where the session context redirects to when the application exits. public  String getInitParameter(String key)      Returns the value of a parameter that was specified when the application has been started. public  Map getInitParameters()      Returns a map of parameters that have been specified when the application has been started. public  Locale getLocale()      public  String getProperty(String key, String defaultValue)      Returns the value for the specified key in the application properties. public  String getRedirectToURL()      Returns the URL a redirect should be sent to. public  long getRequestTicket()      Returns the current request ticket number. public  SessionContext getSessionContext()      public  String getSessionId()      public  int getState()      public  Control getTopControl()      Returns the control that is on top of the stack of visible controls. public  String getTopControlID()      Returns the id of the control that is currently renderd. public  Stack getTopControls()      Returns Stack of pushed Control's. public  UserAgentInfo getUserAgent()      public  boolean isDoExit()      Returns true if the frameset should be left and the data should be purged. public  boolean isRenderingRelevant(Control childControl)      public  boolean isRequireRedraw()      Returns true if the page content has been changed since the last rendering and must be rendered again to reflect the last changes. public  void popTopControl()      Remove the top control from the stack of visible controls. public  void pushTopControl(Control frameControl)      Push a control on the stack of visible controls. public  void redirectTo(String sURL, boolean isExit)      Sends a redirect to the specified URL with the next page update sent to the client. public  void registerControl(Control control, String name)      Add a new FrameControl to this context. public  void removeControl(String name)      Remove a control from the container. public  void removeLayer(String layerId)      Remove the specified layer. public  void removeSessionListener(SessionListener listener)      Adds a SessionListener to this SessionContext.  void removeTopControl(Control control)      Remove the control from the stack of pushed top controls. public  void setActionController(IActionController actionController)       void setApplication(IApplication application)      public  void setCallBackURL(java.lang.String newCallBackURL)      Set the URL that will display the frame/session in the current state.  void setClientId(String clientId)      public  void setExitURL(String string)      Set the URL where the session context redirects to when the application exits.  void setInitParameters(Map initParameter)      public  void setLocale(Locale locale)      Set the Locale for this session. public  void setRequireRedraw(boolean requireRedraw)      Set to true if the page content need to be rendered again to reflect the changes of the application since it was last rendered. public  void setSessionId(String sessionId)       void setUserAgent(UserAgentInfo userAgent)      public  void unregisterControl(Control control)      public  boolean validateTicket(long ticket)      Validates if the ticket number equals the expected ticket number. Field Detail AFTER_DESERIALIZATION final static int AFTER_DESERIALIZATION(Code) BEFORE_SERIALIZATION final static int BEFORE_SERIALIZATION(Code) PROP_APPID final public static String PROP_APPID(Code) PROP_AUTHENTICATION final public static String PROP_AUTHENTICATION(Code) PROP_CONTROL final public static String PROP_CONTROL(Code) PROP_NAME final public static String PROP_NAME(Code) PROP_SERIALIZABLE final public static String PROP_SERIALIZABLE(Code) PROP_SINGLESESSION final public static String PROP_SINGLESESSION(Code) SESSION_REUSED final static int SESSION_REUSED(Code) SESSION_STARTED final static int SESSION_STARTED(Code) SESSION_STOPPED final static int SESSION_STOPPED(Code) STATE_DESTROYED final public static int STATE_DESTROYED(Code) STATE_NORMAL final public static int STATE_NORMAL(Code) STATE_STORED final public static int STATE_STORED(Code) Constructor Detail SessionContext SessionContext(IApplicationSetup appSetup, Locale locale)(Code) Creates a blank new SessionContext. The contstructor is just visible to the package. Method Detail addLayer public void addLayer(String layerID, Control control)(Code) Add a link to a control. A link can be used to render a control in a seperate frame. Parameters:   linkID - Parameters:   control - addSessionListener public void addSessionListener(SessionListener listener)(Code) Adds a SessionListener to this SessionContext. Parameters:   listener - adopt public void adopt(Control control, String name)(Code) clearRedirect public void clearRedirect()(Code) Stop the frame from redirecting to a previous specified URL. destroy public void destroy()(Code) Remove all controls in the context and destroy them. exit public void exit()(Code) Exit the session and clean up all controls. throws:   AgoraException - fireEvent void fireEvent(SessionEvent event, int method)(Code) Fire the specified event/method. Parameters:   event - Parameters:   method - getActionController public IActionController getActionController()(Code) Returns the actionController. getApplication public IApplication getApplication()(Code) Returns the application. getApplicationSetup public IApplicationSetup getApplicationSetup()(Code) Returns the IApplicationSetup this session is based upon. getCallBackURL public java.lang.String getCallBackURL()(Code) Get the URL that will display the frame/session in the current state. java.lang.String getClientId public String getClientId()(Code) Returns the sessionId. getControl public Control getControl(String ctrlName)(Code) Returns the FrameControl specified by its name. FrameControl getControlById public Control getControlById(String ctrlID) throws ControlNotFoundException(Code) Get a control by its control ID. Parameters:   string - getControlByLayerID public Control getControlByLayerID(String layerID)(Code) Returns the FrameControl specified by a link. FrameControl getControls public Iterator getControls()(Code) Returns an Iterator for all FrameControl objects. getExitURL public String getExitURL()(Code) Returns the URL where the session context redirects to when the application exits. getInitParameter public String getInitParameter(String key)(Code) Returns the value of a parameter that was specified when the application has been started. Parameters:   key - getInitParameters public Map getInitParameters()(Code) Returns a map of parameters that have been specified when the application has been started. Returns the initParameter. getLocale public Locale getLocale()(Code) Returns the locale. getProperty public String getProperty(String key, String defaultValue)(Code) Returns the value for the specified key in the application properties. Parameters:   key - Parameters:   defaultValue - getRedirectToURL public String getRedirectToURL()(Code) Returns the URL a redirect should be sent to. getRequestTicket public long getRequestTicket()(Code) Returns the current request ticket number. Returns the requestTicket. getSessionContext public SessionContext getSessionContext()(Code) getSessionId public String getSessionId()(Code) Returns the sessionId. getState public int getState()(Code) Returns the state. getTopControl public Control getTopControl()(Code) Returns the control that is on top of the stack of visible controls. The top control. getTopControlID public String getTopControlID()(Code) Returns the id of the control that is currently renderd. java.lang.String getTopControls public Stack getTopControls()(Code) Returns Stack of pushed Control's. getUserAgent public UserAgentInfo getUserAgent()(Code) Returns the userAgent. isDoExit public boolean isDoExit()(Code) Returns true if the frameset should be left and the data should be purged. isRenderingRelevant public boolean isRenderingRelevant(Control childControl)(Code) isRequireRedraw public boolean isRequireRedraw()(Code) Returns true if the page content has been changed since the last rendering and must be rendered again to reflect the last changes. Returns the requireRedraw. popTopControl public void popTopControl()(Code) Remove the top control from the stack of visible controls. pushTopControl public void pushTopControl(Control frameControl)(Code) Push a control on the stack of visible controls. The top control (including it's childs) is rendered only. Use popTopControl() to return to the previous control. Parameters:   frameControl - redirectTo public void redirectTo(String sURL, boolean isExit)(Code) Sends a redirect to the specified URL with the next page update sent to the client. If the isExit flag is true, all data is purged. Parameters:   sURL - java.lang.String Parameters:   isExit - boolean registerControl public void registerControl(Control control, String name)(Code) Add a new FrameControl to this context. The name can not contain '.', ' ' or '_' characters. removeControl public void removeControl(String name)(Code) Remove a control from the container. removeLayer public void removeLayer(String layerId)(Code) Remove the specified layer. Parameters:   layerId - removeSessionListener public void removeSessionListener(SessionListener listener)(Code) Adds a SessionListener to this SessionContext. Parameters:   listener - removeTopControl void removeTopControl(Control control)(Code) Remove the control from the stack of pushed top controls. Parameters:   control - setActionController public void setActionController(IActionController actionController)(Code) Parameters:   actionController - The actionController to set. setApplication void setApplication(IApplication application)(Code) Parameters:   application - The application to set. setCallBackURL public void setCallBackURL(java.lang.String newCallBackURL)(Code) Set the URL that will display the frame/session in the current state. Parameters:   newCallBackURL - java.lang.String setClientId void setClientId(String clientId)(Code) Parameters:   sessionId - The sessionId to set. setExitURL public void setExitURL(String string)(Code) Set the URL where the session context redirects to when the application exits. Parameters:   string - setInitParameters void setInitParameters(Map initParameter)(Code) Parameters:   initParameter - The initParameter to set. setLocale public void setLocale(Locale locale)(Code) Set the Locale for this session. Parameters:   locale - setRequireRedraw public void setRequireRedraw(boolean requireRedraw)(Code) Set to true if the page content need to be rendered again to reflect the changes of the application since it was last rendered. Parameters:   requireRedraw - The requireRedraw to set. setSessionId public void setSessionId(String sessionId)(Code) Parameters:   sessionId - The sessionId to set. setUserAgent void setUserAgent(UserAgentInfo userAgent)(Code) Parameters:   userAgent - The userAgent to set. unregisterControl public void unregisterControl(Control control)(Code) validateTicket public boolean validateTicket(long ticket)(Code) Validates if the ticket number equals the expected ticket number. If the numbers are equal, true is returned and the request ticket number is increased by one. Parameters:   ticket - Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)