パッケージ org.wcardinal.controller.annotation

Annotation Interface Controller

@Documented @Target(TYPE) @Retention(RUNTIME) @Component @Scope("prototype") public @interface Controller
Marks an annotated class as a controller exposed to browsers.
関連項目:

  • 要素の詳細

    • value

      String[] value
      Relative URLs to fetch an annotated controller. If value() and urls() are omitted, name() in the "Lower-hyphen" format is used as an URL. For instance, if a class name is MyController, an URL is "/my-controller".
      戻り値:
      relative URLs to fetch an annotated controller
      デフォルト:
      {}

    • urls

      String[] urls
      Relative URLs to fetch an annotated controller. If value() and urls() are omitted, name() in the "Lower-hyphen" format is used as an URL. For instance, if a class name is MyController, an URL is "/my-controller".
      戻り値:
      relative URLs to fetch an annotated controller
      デフォルト:
      {}

    • name

      String name
      A name of an annotated controller. The name must not contains any characters other than alphabets. The instances of an annotated controller are created using this name at browsers. For instance, if the name is "MyController", a class "window.MyController" and its instance "window.myController" are created. By default, the class name of an annotated controller is used as the name. Therefore, if the class name is MyController, the name is set to the "MyController".
      戻り値:
      a controller name
      デフォルト:
      ""

    • roles

      String[] roles
      Roles, all of which users accessing an annotated controller must have.
      戻り値:
      roles users accessing an annotated controller must have
      デフォルト:
      {}

    • keepAlive

      KeepAlive keepAlive
      Keep-alive settings.
      戻り値:
      keep-alive settings
      デフォルト:
      @org.wcardinal.controller.annotation.KeepAlive

    • retry

      Retry retry
      Retry settings.
      戻り値:
      retry settings
      デフォルト:
      @org.wcardinal.controller.annotation.Retry

    • protocols

      String[] protocols
      An array of allowed network protocols. Protocols must be one of the followings:
      • websocket
      • polling-x
      The x in the above protocols is a number representing a polling interval in milliseconds. E.g., "polling-1000", "polling-15000". If the polling interval is not specified, namely if the string "polling" is given, the polling interval is set to 100 ms. If an array is empty, the default protocols are used.
      戻り値:
      allowed network protocols
      デフォルト:
      {}

    • separators

      String[] separators
      An array of the two title separators. The first separator is used as the separator between the base title specified by a title tag and the rest of the title. The second separator is used as the separator among the parts of the rest of the title.
      戻り値:
      title separators
      デフォルト:
      {" - ", " / "}

    • separatorMessages

      String[] separatorMessages
      An array of the messages of the two title separators. The first separator is used as the separator between the base title specified by a title tag and the rest of the title. The second separator is used as the separator among the parts of the rest of the title.
      戻り値:
      messages of title separators
      デフォルト:
      {}