Module org.codelibs.saml2
Package org.codelibs.saml2.servlet

Class ServletUtils

java.lang.Object
org.codelibs.saml2.servlet.ServletUtils
public class ServletUtils extends Object
ServletUtils class of Java Toolkit. A class that contains several auxiliary methods related to HttpServletRequest and HttpServletResponse

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    getSelfHost(jakarta.servlet.http.HttpServletRequest request)
     
    static String
    getSelfRoutedURLNoQuery(jakarta.servlet.http.HttpServletRequest request)
    Returns the routed URL of the current host + current view.
    static String
    getSelfURL(jakarta.servlet.http.HttpServletRequest request)
    Returns the URL of the current context + current view + query
    static String
    getSelfURLhost(jakarta.servlet.http.HttpServletRequest request)
    Returns the protocol + the current host + the port (if different than common ports).
    static String
    getSelfURLNoQuery(jakarta.servlet.http.HttpServletRequest request)
    Returns the URL of the current host + current view.
    static boolean
    isHTTPS(jakarta.servlet.http.HttpServletRequest request)
    Check if under https or http protocol
    static org.codelibs.saml2.core.http.HttpRequest
    makeHttpRequest(jakarta.servlet.http.HttpServletRequest req)
    Creates an HttpRequest from an HttpServletRequest.
    static void
    sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location)
    Redirect to location url
    static void
    sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location, Map<String,String> parameters)
    Redirect to location url
    static String
    sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location, Map<String,String> parameters, Boolean stay)
    Redirect to location url

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • makeHttpRequest

      public static org.codelibs.saml2.core.http.HttpRequest makeHttpRequest(jakarta.servlet.http.HttpServletRequest req)
      Creates an HttpRequest from an HttpServletRequest.
      Parameters:
      req - the incoming HttpServletRequest
      Returns:
      a HttpRequest

    • getSelfURLhost

      public static String getSelfURLhost(jakarta.servlet.http.HttpServletRequest request)
      Returns the protocol + the current host + the port (if different than common ports).
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      the HOST URL

    • getSelfHost

      public static String getSelfHost(jakarta.servlet.http.HttpServletRequest request)
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      the server name

    • isHTTPS

      public static boolean isHTTPS(jakarta.servlet.http.HttpServletRequest request)
      Check if under https or http protocol
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      false if https is not active

    • getSelfURL

      public static String getSelfURL(jakarta.servlet.http.HttpServletRequest request)
      Returns the URL of the current context + current view + query
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      current context + current view + query

    • getSelfURLNoQuery

      public static String getSelfURLNoQuery(jakarta.servlet.http.HttpServletRequest request)
      Returns the URL of the current host + current view.
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      current host + current view

    • getSelfRoutedURLNoQuery

      public static String getSelfRoutedURLNoQuery(jakarta.servlet.http.HttpServletRequest request)
      Returns the routed URL of the current host + current view.
      Parameters:
      request - HttpServletRequest object to be processed
      Returns:
      the current routed url

    • sendRedirect

      public static String sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location, Map<String,String> parameters, Boolean stay)
      Redirect to location url
      Parameters:
      response - HttpServletResponse object to be used
      location - target location url
      parameters - GET parameters to be added
      stay - True if we want to stay (returns the url string) False to execute redirection
      Returns:
      string the target URL
      See Also:
      • HttpServletResponse.sendRedirect(String)

    • sendRedirect

      public static void sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location, Map<String,String> parameters)
      Redirect to location url
      Parameters:
      response - HttpServletResponse object to be used
      location - target location url
      parameters - GET parameters to be added
      See Also:
      • HttpServletResponse.sendRedirect(String)

    • sendRedirect

      public static void sendRedirect(jakarta.servlet.http.HttpServletResponse response, String location)
      Redirect to location url
      Parameters:
      response - HttpServletResponse object to be used
      location - target location url
      See Also:
      • HttpServletResponse.sendRedirect(String)