application |
Nom de la variable :
application
Nom de l'interface :
javax.servlet.ServletContext
Etend :
Aucun
Implémentée par :
Classe interne dépendante du container
Type de page JSP :
Disponible dans les pages JSP et dans les pages d'erreur
Description
Le ServletContext permet d'accéder à des ressources partagées dans une application web. Il conserve des valeurs d'attribut représentant l'étendue d'une application JSP. Une valeur d'attribut peut représenter une instance de toute classe Java valide. Le ServletContext permet également de définir un ensemble de méthodes utilisées par une page JSP ou un servlet pour communiquer avec son container ; par exemple, pour obtenir le type MIME d'un fichier, répartir les demandes ou écrire dans un fichier journal. Le container web est chargé d'assurer l'implémentation de l'interface ServletContext. Chaque ServletContext figurant sur un serveur web se voit affecté un préfixe de chemin URI spécifique. Par exemple, un contexte pourrait être en charge de toutes les ressources figurant sous http://www.mycorp.com/catalog. Toutes les demandes commençant par le chemin de demande /catalog, considéré comme le chemin de contexte, sont envoyées à ce contexte de servlet. Les servlets et les pages JSP d'une application web ne peuvent accéder qu'à une seule instance d'un ServletContext. Si l'application web indique qu'elle est distribuable, une seule instance de l'objet ServletContext devra être utilisée par application sur chaque machine virtuelle Java.

getAttribute() |
public Object getAttribute(String name)
Renvoie l'attribut de contexte de servlet avec le nom spécifié, ou la valeur null si ce nom ne possède aucun attribut. Les attributs de contexte peuvent être définis par un servlet ou une page JSP, représentant l'étendue de l'application JSP. Un container peut également utiliser des attributs pour fournir des informations encore non disponibles par le biais de méthodes dans cette interface.

getAttributeNames() |
public java.util.Enumeration getAttributeNames()
Renvoie une Enumeration d'objets String contenant les noms d'attributs disponibles dans ce contexte de servlet.

getContext() |
public ServletContext getContext(String uripath)
Renvoie un objet ServletContext correspondant à un URI spécifié dans le container web. Cette méthode permet aux servlets et aux pages JSP d'accéder à des contextes différents des leurs. Le chemin URI doit être absolu (commençant par "/") et son interprétation dépend du répertoire racine du document du container. Dans un environnement soucieux de sécurité, le container peut renvoyer la valeur null pour un URI donné.

getInitParameter() |
public String getInitParameter(String name)
Renvoie une String contenant la valeur du paramètre d'initialisation de contexte nommée, ou la valeur null si le paramètre n'existe pas. Les paramètres d'initialisation de contexte peuvent être définis dans le descripteur de déploiement de l'application web.

getInitParameterNames() |
public java.util.Enumeration getInitParameterNames()
Renvoie les noms des paramètres d'initialisation du contexte sous forme d'une Enumeration d'objets String, ou d'une Enumeration vide si le contexte ne possède pas de paramètres d'initialisation.

getMajorVersion() |
public int getMajorVersion()
Renvoie la version principale de l'API Java Servlet prise en charge par le container web. Un container conforme à l'API Servlet 2.3 renvoie la valeur 2.

getMimeType() |
public String getMimeType(String filename)
Renvoie le type MIME du fichier spécifié, ou la valeur null si le type MIME est inconnu. Le type MIME est déterminé par la configuration du container web et peut être spécifié dans un descripteur de déploiement d'application web.

getMinorVersion() |
public int getMinorVersion()
Renvoie la version secondaire de l'API Java Servlet prise en charge par le container web. Un container conforme à l'API Servlet 2.3 renvoie la valeur 3.

getNamedDispatcher() |
public RequestDispatcher getNamedDispatcher(String name)
Renvoie un objet RequestDispatcher agissant comme une classe enveloppante pour le servlet ou la page JSP nommé. Les noms des servlets et des pages JSP peuvent être définis dans le descripteur de déploiement de l'application web.

getRealPath() |
public String getRealPath(String path)
Renvoie un objet String contenant le chemin du système de fichiers pour le chemin de contexte spécifié. Cette méthode renvoie la valeur null si le container web ne peut pas transformer le chemin en chemin de système de fichiers pour quelque raison que ce soit (comme par exemple lorsque le contenu provient d'une archive WAR).

getRequestDispatcher() |
public RequestDispatcher getRequestDispatcher(String path)
Renvoie un objet RequestDispatcher agissant comme une classe enveloppante pour la ressource définie pour le chemin de contexte spécifié. La ressource peut être dynamique (servlet ou JSP) ou statique (par exemple, un fichier HTML normal).

getResource() |
public java.net.URL getResource(String path) throws MalformedURLException
Renvoie une URL à la ressource mappée au chemin de contexte spécifié. Cette méthode permet au container web de mettre à la disposition des servlets et des pages JSP une ressource provenant d'autres sources qu'un système de fichiers local, comme par exemple une base de données ou un fichier WAR. L'URL permet d'accéder directement au contenu de la ressource, toute demande de page JSP renverra donc une URL pour le code source JSP par opposition au résultat traité. Utilisez plutôt un objet RequestDispatcher pour inclure les résultats d'une exécution. Cette méthode renvoie une valeur null si aucune ressource n'est mappée au nom de chemin.

getResourceAsStream() |
public java.io.InputStream getResourceAsStream(String path)
Renvoie la ressource mappée au chemin de contexte spécifié sous forme d'objet InputStream. Voir la méthode getResource() pour de plus amples informations.

getServerInfo() |
public String getServerInfo()
Renvoie le nom et la version du container de servlet sur lequel est exécuté le servlet ou la page JSP sous forme d'objet String accompagné du format servername/versionnumber (par exemple, Tomcat/3.2). Un container peut comporter d'autres informations facultatives, comme par exemple des informations relatives à la version Java et au système d'exploitation, indiquées entre parenthèses.

log() |
public void log(String message) public void log(String message, Throwable cause)
Ecrit le message spécifié dans un fichier journal du container web, ou le message spécifié et une trace de pile de l'objet Throwable spécifié dans le fichier journal du servlet. Le nom et le type du fichier journal dépendent du container.

setAttribute() |
public void setAttribute(String name, Object attribute)
Lie un objet au nom d'attribut spécifié dans ce contexte de servlet. Si le nom spécifié est déjà utilisé pour un attribut, cette méthode supprime l'ancien attribut et lie le nom au nouveau.

getServlet() | Déconseillé
public Servlet getServlet(String name) throws ServletException
Cette méthode devait initialement permettre de récupérer un servlet d'un objet ServletContext. Depuis l'API Servlet 2.1, cette méthode renvoie toujours la valeur null et est conservée uniquement pour garantir une compatibilité binaire. Cette méthode sera définitivement supprimée dans une prochaine version de l'API Java Servlet.

getServlets() | Déconseillé
public Enumeration getServlets()
Cette méthode devait initialement permettre de renvoyer une Enumeration de tous les servlets connus pour ce contexte de servlet. Depuis l'API Servlet 2.1, cette méthode renvoie toujours une Enumeration vide et est conservée uniquement pour garantir une compatibilité binaire. Cette méthode sera définitivement supprimée dans une prochaine version de l'API Java Servlet.

getServletNames() | Déconseillé
public Enumeration getServletNames()
Cette méthode devait initialement permettre de renvoyer une Enumeration de tous les noms de servlet connus pour ce contexte. Depuis l'API Servlet 2,1, cette méthode renvoie toujours une Enumeration vide et est conservée uniquement pour garantir une compatibilité binaire. Cette méthode sera définitivement supprimée dans une prochaine version de l'API Java Servlet.

log() | Déconseillé
public void log(Exception exception, String message)
Cette méthode devait initialement permettre d'écrire la trace de pile d'une exception et un message explicatif de l'erreur dans le fichier journal du container web. Depuis l'API Servlet 2.1, il est plutôt recommandé d'utiliser l'objet log(String, Throwable).