クラス MockServletContext

java.lang.ObjectSE
org.springframework.mock.web.MockServletContext
実装されているすべてのインターフェース:
jakarta.servlet.ServletContext
public class MockServletContext extends ObjectSE implements jakarta.servlet.ServletContext
ServletContext インターフェースのモック実装。

Spring 7.0 以降、このモックのセットは Servlet 6.1 ベースラインに基づいて設計されています。

Servlet 6.1 と互換性がありますが、setMajorVersion(int)/setMinorVersion(int) を介して特定のバージョンを公開するように設定できます。デフォルトは 6.1 です。一部のサーブレット SPI のサポートには制限があります。サーブレット、フィルター、リスナーの登録メソッドはサポートされていません。JSP 設定もサポートされていません。これらの登録メソッドが使用される ServletContainerInitializers および WebApplicationInitializers のユニットテストは、一般的に推奨されません。

テスト環境で完全な WebApplicationContext をセットアップするには、AnnotationConfigWebApplicationContext、XmlWebApplicationContext、GenericWebApplicationContext を使用して、対応する MockServletContext インスタンスを渡すことができます。リソースパスを相対的なファイルシステムの場所として解釈するために、MockServletContext を FileSystemResourceLoader で構成することを検討してください。

導入:
1.0.2
作成者:
Rod Johnson, Juergen Hoeller, Sam Brannen
関連事項:

  • コンストラクターの詳細

    • MockServletContext

      public MockServletContext()
      ベースパスと DefaultResourceLoader（つまり、WAR ルートとしてのクラスパスルート）を使用せずに、新しい MockServletContext を作成します。
      関連事項:

    • MockServletContext

      public MockServletContext(StringSE resourceBasePath)
      DefaultResourceLoader を使用して、新しい MockServletContext を作成します。
      パラメーター:
      resourceBasePath - WAR のルートディレクトリ (スラッシュで終わらないでください)
      関連事項:

    • MockServletContext

      public MockServletContext(@Nullable ResourceLoader resourceLoader)
      指定された ResourceLoader を使用し、ベースパスを使用せずに、新しい MockServletContext を作成します。
      パラメーター:
      resourceLoader - 使用する ResourceLoader (またはデフォルトの場合は null)

    • MockServletContext

      public MockServletContext(StringSE resourceBasePath, @Nullable ResourceLoader resourceLoader)
      提供されたリソースベースパスとリソースローダーを使用して、新しい MockServletContext を作成します。

      'default' という名前のサーブレットの MockRequestDispatcher を登録します。

      パラメーター:
      resourceBasePath - WAR のルートディレクトリ (スラッシュで終わらないでください)
      resourceLoader - 使用する ResourceLoader (またはデフォルトの場合は null)
      関連事項:

  • メソッドの詳細

    • getResourceLocation

      protected StringSE getResourceLocation(StringSE path)
      指定されたパスの完全なリソースの場所を作成し、この MockServletContext のリソースベースパスを先頭に追加します。
      パラメーター:
      path - 指定されたパス
      戻り値:
      完全なリソースパス

    • setContextPath

      public void setContextPath(StringSE contextPath)

    • getContextPath

      public StringSE getContextPath()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getContextPath 

    • registerContext

      public void registerContext(StringSE contextPath, jakarta.servlet.ServletContext context)

    • getContext

      public @Nullable jakarta.servlet.ServletContext getContext(StringSE contextPath)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getContext 

    • setMajorVersion

      public void setMajorVersion(int majorVersion)

    • getMajorVersion

      public int getMajorVersion()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getMajorVersion 

    • setMinorVersion

      public void setMinorVersion(int minorVersion)

    • getMinorVersion

      public int getMinorVersion()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getMinorVersion 

    • setEffectiveMajorVersion

      public void setEffectiveMajorVersion(int effectiveMajorVersion)

    • getEffectiveMajorVersion

      public int getEffectiveMajorVersion()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getEffectiveMajorVersion 

    • setEffectiveMinorVersion

      public void setEffectiveMinorVersion(int effectiveMinorVersion)

    • getEffectiveMinorVersion

      public int getEffectiveMinorVersion()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getEffectiveMinorVersion 

    • getMimeType

      public @Nullable StringSE getMimeType(StringSE filePath)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getMimeType 

    • addMimeType

      public void addMimeType(StringSE fileExtension, MediaType mimeType)
      getMimeType(String) が使用する MIME 型マッピングを追加します。
      パラメーター:
      fileExtension - txt、gif などのファイル拡張子
      mimeType - MIME 型

    • getResourcePaths

      public @Nullable SetSE<StringSE> getResourcePaths(StringSE path)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getResourcePaths 

    • getResource

      public @Nullable URLSE getResource(StringSE path) throws MalformedURLExceptionSE
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getResource 
      例外:
      MalformedURLExceptionSE

    • getResourceAsStream

      public @Nullable InputStreamSE getResourceAsStream(StringSE path)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getResourceAsStream 

    • getRequestDispatcher

      public jakarta.servlet.RequestDispatcher getRequestDispatcher(StringSE path)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getRequestDispatcher 

    • getNamedDispatcher

      public @Nullable jakarta.servlet.RequestDispatcher getNamedDispatcher(StringSE path)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getNamedDispatcher 

    • registerNamedDispatcher

      public void registerNamedDispatcher(StringSE name, jakarta.servlet.RequestDispatcher requestDispatcher)
      名前付きサーブレットのラッパーとして機能する RequestDispatcher (通常は MockRequestDispatcher) を登録します。
      パラメーター:
      name - ラップされたサーブレットの名前
      requestDispatcher - 名前付きサーブレットをラップするディスパッチャー
      関連事項:

    • unregisterNamedDispatcher

      public void unregisterNamedDispatcher(StringSE name)
      指定された名前の RequestDispatcher を登録解除します。
      パラメーター:
      name - 登録を解除するディスパッチャーの名前
      関連事項:

    • getDefaultServletName

      public StringSE getDefaultServletName()
      デフォルトの  Servlet の名前を取得します。

      デフォルトは 'default' です。

      関連事項:

    • setDefaultServletName

      public void setDefaultServletName(StringSE defaultServletName)
      デフォルトの  Servlet の名前を設定します。

      また、現在のデフォルトの RequestDispatcher を unregisters し、提供されている defaultServletName を MockRequestDispatcher で replaces します。

      パラメーター:
      defaultServletName - デフォルトの  Servlet の名前。null または空にしない
      関連事項:

    • log

      public void log(StringSE message)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の log 

    • log

      public void log(StringSE message, ThrowableSE ex)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の log 

    • getRealPath

      public @Nullable StringSE getRealPath(StringSE path)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getRealPath 

    • getServerInfo

      public StringSE getServerInfo()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getServerInfo 

    • getInitParameter

      public @Nullable StringSE getInitParameter(StringSE name)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getInitParameter 

    • getInitParameterNames

      public EnumerationSE<StringSE> getInitParameterNames()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getInitParameterNames 

    • setInitParameter

      public boolean setInitParameter(StringSE name, StringSE value)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setInitParameter 

    • addInitParameter

      public void addInitParameter(StringSE name, StringSE value)

    • getAttribute

      public @Nullable ObjectSE getAttribute(StringSE name)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getAttribute 

    • getAttributeNames

      public EnumerationSE<StringSE> getAttributeNames()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getAttributeNames 

    • setAttribute

      public void setAttribute(StringSE name, @Nullable ObjectSE value)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setAttribute 

    • removeAttribute

      public void removeAttribute(StringSE name)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の removeAttribute 

    • setServletContextName

      public void setServletContextName(StringSE servletContextName)

    • getServletContextName

      public StringSE getServletContextName()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getServletContextName 

    • getClassLoader

      public @Nullable ClassLoaderSE getClassLoader()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getClassLoader 

    • declareRoles

      public void declareRoles(StringSE... roleNames)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の declareRoles 

    • getDeclaredRoles

      public SetSE<StringSE> getDeclaredRoles()

    • setSessionTrackingModes

      public void setSessionTrackingModes(SetSE<jakarta.servlet.SessionTrackingMode> sessionTrackingModes) throws IllegalStateExceptionSE, IllegalArgumentExceptionSE
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setSessionTrackingModes 
      例外:
      IllegalStateExceptionSE
      IllegalArgumentExceptionSE

    • getDefaultSessionTrackingModes

      public SetSE<jakarta.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getDefaultSessionTrackingModes 

    • getEffectiveSessionTrackingModes

      public SetSE<jakarta.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getEffectiveSessionTrackingModes 

    • getSessionCookieConfig

      public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getSessionCookieConfig 

    • setSessionTimeout

      public void setSessionTimeout(int sessionTimeout)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setSessionTimeout 

    • getSessionTimeout

      public int getSessionTimeout()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getSessionTimeout 

    • setRequestCharacterEncoding

      public void setRequestCharacterEncoding(@Nullable StringSE requestCharacterEncoding)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setRequestCharacterEncoding 

    • getRequestCharacterEncoding

      public @Nullable StringSE getRequestCharacterEncoding()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getRequestCharacterEncoding 

    • setResponseCharacterEncoding

      public void setResponseCharacterEncoding(@Nullable StringSE responseCharacterEncoding)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の setResponseCharacterEncoding 

    • getResponseCharacterEncoding

      public @Nullable StringSE getResponseCharacterEncoding()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getResponseCharacterEncoding 

    • addFilterRegistration

      public void addFilterRegistration(jakarta.servlet.FilterRegistration registration)
      FilterRegistration を追加します。
      導入:
      6.2

    • getFilterRegistration

      public @Nullable jakarta.servlet.FilterRegistration getFilterRegistration(StringSE filterName)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getFilterRegistration 

    • getFilterRegistrations

      public MapSE<StringSE, ? extends jakarta.servlet.FilterRegistration> getFilterRegistrations()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getFilterRegistrations 

    • getJspConfigDescriptor

      public jakarta.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getJspConfigDescriptor 

    • addJspFile

      public jakarta.servlet.ServletRegistration.Dynamic addJspFile(StringSE servletName, StringSE jspFile)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addJspFile 

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(StringSE servletName, StringSE className)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addServlet 

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(StringSE servletName, jakarta.servlet.Servlet servlet)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addServlet 

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(StringSE servletName, ClassSE<? extends jakarta.servlet.Servlet> servletClass)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addServlet 

    • createServlet

      public <T extends jakarta.servlet.Servlet> T createServlet(ClassSE<T> c) throws jakarta.servlet.ServletException
      次で指定:
      インターフェース jakarta.servlet.ServletContext の createServlet 
      例外:
      jakarta.servlet.ServletException

    • getServletRegistration

      public @Nullable jakarta.servlet.ServletRegistration getServletRegistration(StringSE servletName)
      このメソッドは常に null を返します。
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getServletRegistration 
      関連事項:
      • ServletContext.getServletRegistration(java.lang.String)

    • getServletRegistrations

      public MapSE<StringSE, ? extends jakarta.servlet.ServletRegistration> getServletRegistrations()
      このメソッドは常に空のマップを返します。
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getServletRegistrations 
      関連事項:
      • ServletContext.getServletRegistrations()

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(StringSE filterName, StringSE className)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addFilter 

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(StringSE filterName, jakarta.servlet.Filter filter)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addFilter 

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(StringSE filterName, ClassSE<? extends jakarta.servlet.Filter> filterClass)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addFilter 

    • createFilter

      public <T extends jakarta.servlet.Filter> T createFilter(ClassSE<T> c) throws jakarta.servlet.ServletException
      次で指定:
      インターフェース jakarta.servlet.ServletContext の createFilter 
      例外:
      jakarta.servlet.ServletException

    • addListener

      public void addListener(ClassSE<? extends EventListenerSE> listenerClass)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addListener 

    • addListener

      public void addListener(StringSE className)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addListener 

    • addListener

      public <T extends EventListenerSE> void addListener(T t)
      次で指定:
      インターフェース jakarta.servlet.ServletContext の addListener 

    • createListener

      public <T extends EventListenerSE> T createListener(ClassSE<T> c) throws jakarta.servlet.ServletException
      次で指定:
      インターフェース jakarta.servlet.ServletContext の createListener 
      例外:
      jakarta.servlet.ServletException

    • getVirtualServerName

      public StringSE getVirtualServerName()
      次で指定:
      インターフェース jakarta.servlet.ServletContext の getVirtualServerName