パッケージ org.wcardinal.controller

インタフェース ControllerContext

すべてのスーパーインタフェース:
Unlockable
既知のサブインタフェースのリスト:
ComponentContext, ComponentFactory<T>, Factory<T>, PageContext, PageFactory<T>, PopupContext, PopupFactory<T>, VisibilityControllerContext
既知の実装クラスのリスト:
AbstractComponent, AbstractController, AbstractPage, AbstractPopup, AbstractVisibilityController, ComponentController, ComponentFacade, ComponentFactoryController, ComponentFactoryImpl, Controller, ControllerFacade, FactoryController, FactoryImpl, PageController, PageFacade, PageFactoryController, PageFactoryImpl, PopupController, PopupFacade, PopupFactoryController, PopupFactoryImpl, RootController, SharedComponentController, VisibilityController
public interface ControllerContext extends Unlockable
Central interface to provide methods for controllers.

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    boolean
    cancel()
    Cancels the current request issued by timeout or interval methods, or the current task.
    boolean
    cancel(long id)
    Cancels the request of the specified ID issued by timeout or interval methods.
    boolean
    cancel(String reason)
    Cancels the current task.
    void
    cancelAll()
    Cancels all requests issued by timeout or interval methods.
    Future<?>
    execute(Runnable runnable)
    Requests to execute the specified runnable.
    void
    execute(String name, Object... parameters)
    Requests to execute methods annotated with the OnTime of the specified name.
    <T> Future<T>
    execute(Callable<T> callable)
    Requests to execute the specified callable.
    <T> T
    getActivePage()
    Returns the active page or null.
    ControllerAttributes
    getAttributes()
    Returns the attributes.
    com.fasterxml.jackson.databind.node.ArrayNode
    getFactoryParameters()
    Returns the factory parameters.
    Locale
    getLocale()
    Returns the preferred locale.
    List<Locale>
    getLocales()
    Returns the locale objects in decreasing order starting with the preferred locale.
    String
    getName()
    Returns the name of this controller.
    String
    getParameter(String key)
    Returns the first parameter of the specified key.
    Map<String,String[]>
    getParameterMap()
    Returns the map of parameters.
    String[]
    getParameters(String key)
    Returns the parameters of the specified key.
    <T> T
    getParent()
    Returns the parent.
    Factory<?>
    getParentAsFactory()
    Returns the parent as a factory.
    <T> Collection<T>
    getParents()
    Returns the parents.
    Principal
    getPrincipal()
    Returns the user principle.
    String
    getRemoteAddress()
    Returns the user's remote address.
    Scheduler
    getScheduler()
    Returns the scheduler.
    String
    getSessionId()
    Returns the session ID.
    String
    getSubSessionId()
    Returns the sub session ID.
    void
    hide()
    Hides this controller.
    long
    interval(Runnable runnable, long interval)
    Requests to call the specified runnable at the specified interval and returns an ID of this request.
    long
    interval(Runnable runnable, long startAfter, long interval)
    Requests to call the specified runnable at the specified interval after the 'startAfter' milliseconds and returns an ID of this request.
    long
    interval(String name, long interval)
    Requests to call methods annotated with the OnTime of the specified name at the specified interval and returns an ID of this request.
    long
    interval(String name, long startAfter, long interval, Object... parameters)
    Requests to call methods annotated with the OnTime of the specified name at the specified interval after the 'startAfter' milliseconds and returns an ID of this request.
    boolean
    isCanceled()
    Returns true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing.
    boolean
    isHeadCall()
    Returns true if the thread calling this method is the forefront executor of methods annotated with Tracked.
    boolean
    isHidden()
    Returns true if this controller is hidden.
    boolean
    isHistorical()
    Returns true if this controller is historical.
    boolean
    isLocked()
    Returns true if this controller is locked.
    boolean
    isLockedByCurrentThread()
    Returns true if this controller is locked by the current thread.
    boolean
    isNonNull()
    Returns true if this controller is non-null.
    boolean
    isReadOnly()
    Returns true if this controller is read-only.
    boolean
    isShown()
    Returns true if this controller is shown.
    Unlocker
    lock()
    Locks this controller.
    void
    notify(String name, Object... parameters)
    Requests to call methods annotated with the OnNotice of the specified name.
    void
    notifyAsync(String name, Object... parameters)
    Requests to call methods annotated with the OnNotice of the specified name asynchronously.
    void
    show()
    Shows this controller.
    long
    timeout(Runnable runnable, long delay)
    Requests to call the specified runnable after the specified delay and returns an ID of this request.
    long
    timeout(String name, long delay, Object... parameters)
    Requests to call methods annotated with the OnTime of the specified name after the specified delay and returns an ID of this request.
    <T> TimeoutFuture<T>
    timeout(Callable<T> callable, long delay)
    Requests to call the specified callable after the specified delay.
    void
    trigger(String name, Object... arguments)
    Triggers the event of the given name at browsers.
    TriggerResult
    triggerAndWait(String name, long timeout, Object... arguments)
    Triggers the event of the specified name at browsers and waits for responses from browsers.
    void
    triggerDirect(String name, Object... arguments)
    Triggers the event of the given name at browsers directly.
    boolean
    tryLock()
    Tries to lock this controller.
    boolean
    tryLock(long timeout, TimeUnit unit)
    Tries to lock this controller.
    void
    unlock()
    Unlocks this controller.

  • メソッドの詳細

    • lock

      @ThreadSafe Unlocker lock()
      Locks this controller.

      Please note that all the fields and controllers belonging to the same controller instance share a lock. Thus, the followings is not necessary: 

       @Controller
 class MyController {
   @Autowired
   SString name;

   @Autowired
   SInteger score;

   @OnChange("name")
   void onChange(){
     try( Unlocker unlocker = score.lock() ){ // Unnecessary
       score.set( 0 );
     }
   }
 }
      When the 'onChange' method is called, the 'name' field is locked. And the 'name' field, the 'score' field and the 'MyController' controller share a lock. The 'score' field, therefore, is locked at the time the 'onChange' method is called. The only exception to this is a component annotated with SharedComponent. Shared components and fields on them do not share a lock with the others. Because shared components do not share a lock, the lock ordering is necessary to avoid concurrency issues. If locking a shared component and one of its parents at once is unavoidable, must lock a parent at first. And then lock a shared component. 
       @SharedComponent
 class MySharedComponent{}

 @Controller
 class MyController {
   @Autowired
   MySharedComponent component;

   void foo(){
     // At first lock itself, the parent of the 'this.component'
     try( Unlocker parent = lock() ) {
       // Then lock a shared component
       try( Unlocker child = component.lock() ) {
         // Do something here
       }
     }
   }
 }
      戻り値:
      Unlocker instance for unlocking this lock

    • tryLock

      @ThreadSafe boolean tryLock()
      Tries to lock this controller.
      戻り値:
      true if succeeded

    • tryLock

      @ThreadSafe boolean tryLock(long timeout, TimeUnit unit)
      Tries to lock this controller.
      パラメータ:
      timeout - the timeout for this trial
      unit - the unit of the timeout
      戻り値:
      true if succeeded

    • isLocked

      @ThreadSafe boolean isLocked()
      Returns true if this controller is locked.
      戻り値:
      true if this controller is locked.

    • isLockedByCurrentThread

      @ThreadSafe boolean isLockedByCurrentThread()
      Returns true if this controller is locked by the current thread.
      戻り値:
      true if this controller is locked by the current thread.

    • isReadOnly

      @ThreadSafe boolean isReadOnly()
      Returns true if this controller is read-only.
      戻り値:
      true if this controller is read-only.

    • isNonNull

      @ThreadSafe boolean isNonNull()
      Returns true if this controller is non-null.
      戻り値:
      true if this controller is non-null.

    • isHistorical

      @ThreadSafe boolean isHistorical()
      Returns true if this controller is historical.
      戻り値:
      true if this controller is historical.

    • unlock

      @ThreadSafe void unlock()
      Unlocks this controller.
      定義:
      unlock インタフェース内 Unlockable

    • getName

      @ThreadSafe String getName()
      Returns the name of this controller.
      戻り値:
      the name of this controller

    • getParent

      @ThreadSafe <T> T getParent()
      Returns the parent.
      型パラメータ:
      T - the type of parent
      戻り値:
      the parent instance

    • getParentAsFactory

      @ThreadSafe Factory<?> getParentAsFactory()
      Returns the parent as a factory.
      戻り値:
      the parent instance

    • getParents

      @ThreadSafe <T> Collection<T> getParents()
      Returns the parents.
      型パラメータ:
      T - the type of parents
      戻り値:
      the parent instances

    • getActivePage

      @ThreadSafe <T> T getActivePage()
      Returns the active page or null.
      型パラメータ:
      T - the type of the active page
      戻り値:
      the active page

    • getParameter

      @ThreadSafe String getParameter(String key)
      Returns the first parameter of the specified key. The parameters are taken from the query string or posted form data. 
       // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
      System.out.println( getParameter("name") ); // prints "Cardinal"
   }
 }
      パラメータ:
      key - the key of the parameter
      戻り値:
      the first parameter of the specified key

    • getParameters

      @ThreadSafe String[] getParameters(String key)
      Returns the parameters of the specified key. The parameters are taken from the query string or posted form data. 
       // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
     System.out.println( Arrays.toString(getParameters("name")) ); // prints ["Cardinal"]
   }
 }
      パラメータ:
      key - the key of the parameters
      戻り値:
      the parameters of the specified key

    • getParameterMap

      @ThreadSafe Map<String,String[]> getParameterMap()
      Returns the map of parameters. The parameters are taken from the query string or posted form data. 
       // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
     System.out.println( getParameterMap("name") ); // prints {name=["Cardinal"]}
   }
 }
      戻り値:
      the map of parameters

    • getFactoryParameters

      @ThreadSafe com.fasterxml.jackson.databind.node.ArrayNode getFactoryParameters()
      Returns the factory parameters. The factory parameters are the parameters given to the method Factory.create(Object...). 
       @Controller
 class MyController {
   @Autowired
   ComponentFactory<MyComponent> factory;

   @OnCreate
   void onCreate(){
     factory.create(1, "Cardinal");
   }
 }

 class MyComponent extends AbstractComponent {
   @OnCreate
   void onCreate(){
     System.out.println( getFactoryParameters() ); // prints [1, "Cardinal"]
   }
 }
      戻り値:
      the factory parameters.

    • getAttributes

      @ThreadSafe ControllerAttributes getAttributes()
      Returns the attributes.
      戻り値:
      the attributes.

    • getLocales

      @ThreadSafe List<Locale> getLocales()
      Returns the locale objects in decreasing order starting with the preferred locale.
      戻り値:
      the locale objects

    • getLocale

      @ThreadSafe Locale getLocale()
      Returns the preferred locale.
      戻り値:
      the preferred locale

    • show

      @ThreadSafe void show()
      Shows this controller.

    • hide

      @ThreadSafe void hide()
      Hides this controller.

    • isShown

      @ThreadSafe boolean isShown()
      Returns true if this controller is shown.
      戻り値:
      true if this controller is shown.

    • isHidden

      @ThreadSafe boolean isHidden()
      Returns true if this controller is hidden.
      戻り値:
      true if this controller is hidden.

    • getRemoteAddress

      @ThreadSafe String getRemoteAddress()
      Returns the user's remote address.
      戻り値:
      user's remote address

    • getPrincipal

      @ThreadSafe Principal getPrincipal()
      Returns the user principle.
      戻り値:
      user principle

    • getScheduler

      Scheduler getScheduler()
      Returns the scheduler.
      戻り値:
      the scheduler

    • execute

      @ThreadSafe void execute(String name, Object... parameters)
      Requests to execute methods annotated with the OnTime of the specified name.
      パラメータ:
      name - method name specified by OnTime
      parameters - parameters to be passed to the specified methods

    • execute

      @ThreadSafe Future<?> execute(Runnable runnable)
      Requests to execute the specified runnable.
      パラメータ:
      runnable - runnable to be executed
      戻り値:
      future

    • execute

      @ThreadSafe <T> Future<T> execute(Callable<T> callable)
      Requests to execute the specified callable.
      型パラメータ:
      T - return type of the specified callable
      パラメータ:
      callable - callable to be executed
      戻り値:
      future

    • timeout

      @ThreadSafe long timeout(String name, long delay, Object... parameters)
      Requests to call methods annotated with the OnTime of the specified name after the specified delay and returns an ID of this request. Use the returned ID and cancel(long) for canceling the request.
      パラメータ:
      name - method name specified by OnTime
      delay - delay in milliseconds
      parameters - parameters to be passed to the specified methods
      戻り値:
      request ID
      関連項目:

    • timeout

      @ThreadSafe long timeout(Runnable runnable, long delay)
      Requests to call the specified runnable after the specified delay and returns an ID of this request. Use the returned ID and cancel(long) for canceling the request.
      パラメータ:
      runnable - runnable to be executed
      delay - delay in milliseconds
      戻り値:
      request ID
      関連項目:

    • timeout

      @ThreadSafe <T> TimeoutFuture<T> timeout(Callable<T> callable, long delay)
      Requests to call the specified callable after the specified delay. Use the returned ID and cancel(long) for canceling the request.
      型パラメータ:
      T - return type of the specified callable
      パラメータ:
      callable - callable to be executed
      delay - delay in milliseconds
      戻り値:
      future
      関連項目:

    • interval

      @ThreadSafe long interval(String name, long interval)
      Requests to call methods annotated with the OnTime of the specified name at the specified interval and returns an ID of this request. Use the returned ID and cancel(long), or cancel() for canceling the request. The first call is taking place after the milliseconds specified as the interval.
      パラメータ:
      name - method name specified by OnTime
      interval - interval in milliseconds
      戻り値:
      request ID
      関連項目:

    • interval

      @ThreadSafe long interval(String name, long startAfter, long interval, Object... parameters)
      Requests to call methods annotated with the OnTime of the specified name at the specified interval after the 'startAfter' milliseconds and returns an ID of this request. Use the returned ID and cancel(long), or cancel() for canceling the request. The first call is taking place after the 'startAfter' milliseconds.
      パラメータ:
      name - method name specified by OnTime
      startAfter - delay of the first call in milliseconds
      interval - interval in milliseconds
      parameters - parameters to be passed to the specified methods
      戻り値:
      request ID
      関連項目:

    • interval

      @ThreadSafe long interval(Runnable runnable, long interval)
      Requests to call the specified runnable at the specified interval and returns an ID of this request. Use the returned ID and cancel(long), or cancel() for canceling the request. The first call is taking place after the milliseconds specified as the interval.
      パラメータ:
      runnable - runnable to be executed
      interval - interval in milliseconds
      戻り値:
      request ID
      関連項目:

    • interval

      @ThreadSafe long interval(Runnable runnable, long startAfter, long interval)
      Requests to call the specified runnable at the specified interval after the 'startAfter' milliseconds and returns an ID of this request. Use the returned ID and cancel(long), or cancel() for canceling the request. The first call is taking place after the 'startAfter' milliseconds.
      パラメータ:
      runnable - runnable to be executed
      startAfter - delay of the first call in milliseconds
      interval - interval in milliseconds
      戻り値:
      request ID
      関連項目:

    • cancel

      @ThreadSafe boolean cancel(long id)
      Cancels the request of the specified ID issued by timeout or interval methods.
      パラメータ:
      id - request ID
      戻り値:
      true if succeeded
      関連項目:

    • cancel

      @ThreadSafe boolean cancel()
      Cancels the current request issued by timeout or interval methods, or the current task. Under the hood, a thread local is used to distinguish requests/tasks. 
       @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     interval( "update", 1000 );
   }

   @OnTime
   void update(){
     // Stops the "update" by itself
     cancel();
   }
 }
      戻り値:
      true if succeeded
      関連項目:

    • cancel

      @ThreadSafe boolean cancel(String reason)
      Cancels the current task. Under the hood, a thread local is used to distinguish tasks.
      パラメータ:
      reason - a cancel reason
      戻り値:
      true if succeeded

    • cancelAll

      @ThreadSafe void cancelAll()
      Cancels all requests issued by timeout or interval methods.
      関連項目:

    • isCanceled

      @ThreadSafe boolean isCanceled()
      Returns true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing. Under the hood, a thread local is used to distinguish requests/tasks
      戻り値:
      true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing

    • isHeadCall

      @ThreadSafe boolean isHeadCall()
      Returns true if the thread calling this method is the forefront executor of methods annotated with Tracked.
      戻り値:
      true if the thread calling this method is the forefront executor of methods annotated with Tracked

    • trigger

      @ThreadSafe void trigger(String name, Object... arguments)
      Triggers the event of the given name at browsers. Optional arguments are passed to browsers as event data. 
       // JavaScript
 myController.on( 'hello', function( e, name ){
   console.log( name ); // prints 'Cardinal'
 });

 // Java
 @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     timeout( "hello", 5000 );
   }

   @OnTime
   void hello(){
     trigger( "hello", "Cardinal" );
   }
 }
      パラメータ:
      name - event name
      arguments - event data
      関連項目:

    • triggerDirect

      @ThreadSafe void triggerDirect(String name, Object... arguments)
      Triggers the event of the given name at browsers directly. Only difference between trigger(String, Object...) and this is this method sends trigger events directly by bypassing the most of the costly synchronization processes. Thus, in general, supposed to be faster than trigger(String, Object...). However, because of this, weak against network disconnections.
      パラメータ:
      name - event name
      arguments - event data
      関連項目:

    • triggerAndWait

      @ThreadSafe TriggerResult triggerAndWait(String name, long timeout, Object... arguments)
      Triggers the event of the specified name at browsers and waits for responses from browsers. Optional arguments are passed to browsers as event data. When a browser send back responses within a given period of time, the callback DoneCallback set to the Promise.done(org.jdeferred.DoneCallback) is called. Otherwise, the callback FailCallback set to the Promise.fail(org.jdeferred.FailCallback) is called. 
       // JavaScript
 myController.on( 'hello', function( e, name ){
   console.log( name ); // prints 'Cardinal'
   return 'Hello, '+name;
 });

 // Java
 @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     timeout( "hello", 5000 );
   }

   @OnTime
   void hello(){
     trigger( "hello", 3000, "Cardinal" )
     .done(new DoneCallback<List<JsonNode>>(){
       public void onDone(List<JsonNode> result) {
         System.out.println( result.get( 0 ).asText() ); // prints "Hello, Cardinal"
       }
     });
   }
 }
      パラメータ:
      name - event name
      timeout - timeout for this trigger in milliseconds
      arguments - event data
      戻り値:
      promise instance
      関連項目:

    • notify

      void notify(String name, Object... parameters)
      Requests to call methods annotated with the OnNotice of the specified name. Notifications propagate to parents. To catch a notification triggered by a child, use a name prefixed with a child name. 
       @Component
 class MyComponent extends AbstractComponent {
   void notifyBar(){
     notify( "bar" );
   }
 }

 @Controller
 class MyController {
   @Autowired
   MyComponent foo;

   @OnNotice("foo.bar")
   void onNotice(){
     // Called when the child 'foo' sends a 'bar' notification
   }
 }
      パラメータ:
      name - notification name
      parameters - notification parameters
      関連項目:

    • notifyAsync

      void notifyAsync(String name, Object... parameters)
      Requests to call methods annotated with the OnNotice of the specified name asynchronously. Notifications propagate to parents. To catch a notification triggered by a child, use a name prefixed with a child name. 
       @Component
 class MyComponent extends AbstractComponent {
   void notifyBar(){
     notifyAsync( "bar" );
   }
 }

 @Controller
 class MyController {
   @Autowired
   MyComponent foo;

   @OnNotice("foo.bar")
   void onNotice(){
     // Called when the child 'foo' sends a 'bar' notification
   }
 }
      パラメータ:
      name - notification name
      parameters - notification parameters
      関連項目:

    • getSessionId

      String getSessionId()
      Returns the session ID.
      戻り値:
      the session ID

    • getSubSessionId

      String getSubSessionId()
      Returns the sub session ID.
      戻り値:
      the sub session ID