org.mashupbots.socko.rest

RestEndPoint

case class RestEndPoint(method: String, rootPath: String, relativePath: String) extends Product with Serializable

The HTTP method and path to a REST operation

method

HTTP method. e.g. GET.

rootPath

Root path of the REST service. e.g. /api.

relativePath

Path relative to the rootPath for the REST operation

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RestEndPoint
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RestEndPoint(method: String, rootPath: String, relativePath: String)

    method

    HTTP method. e.g. GET.

    rootPath

    Root path of the REST service. e.g. /api.

    relativePath

    Path relative to the rootPath for the REST operation

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def comparePath(restEndPoint: RestEndPoint): Boolean

    Compares the URL of this operation to another.

    Compares the URL of this operation to another.

    Comparison is based on method and path segments.

    For example, GET /pets/{id} is the same as GET /{type}/{id} because {type} is a variable and can contain pets.

    However, the following are different:

    • GET /pets is different to GET /users because the static paths are different
    • DELETE /pets/{id} is different to PUT /pets/{id} because methods are different
    returns

    True if the URI templates are ambiguous and 2 or more unique end points can resolve to either URI templates. False otherwise..

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. val fullPath: String

    Full path from combining the rootPath with relativePath.

  12. val fullPathSegments: List[PathSegment]

    The full path split into path segments for ease of matching

    The full path split into path segments for ease of matching

    Example Usage

    If path = /user/{Id} and rootUrl in the config is /api, the full path segment are

    List(
    PathSegment("api", false),
    PathSegment("user", false),
    PathSegment("Id", true)
    )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. def matchEndPoint(endpoint: EndPoint): Boolean

    Compares the URL template with the specified end point.

    Compares the URL template with the specified end point.

    For example, GET /pets/{id} matches the end point GET /pets/123.

    endpoint

    End point to match

    returns

    True if this is a match; False if not a match.

  16. val method: String

    HTTP method.

    HTTP method. e.g. GET.

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val relativePath: String

    Path relative to the rootPath for the REST operation

  21. val relativePathSegments: List[PathSegment]

    The relative URL template split into path segments for ease of matching

    The relative URL template split into path segments for ease of matching

    Example Usage

    If path = /user/{Id} and rootUrl in the config is /api, the relative path segment are

    List(
    PathSegment("user", false),
    PathSegment("Id", true)
    )
  22. val rootPath: String

    Root path of the REST service.

    Root path of the REST service. e.g. /api.

  23. val staticFullPathSegementsCount: Int

    Number of static path segments.

    Number of static path segments. Used to determine best match

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped