-
public interface StepContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description BatchStatus
getBatchStatus()
The getBatchStatus method returns the current batch status of the current step.Exception
getException()
The getException method returns the last exception thrown from a step level batch artifact to the batch runtime.String
getExitStatus()
The getExitStatus method simply returns the exit status value stored into the step context through the setExitStatus method or null.Metric[]
getMetrics()
The getMetrics method returns an array of step level metrics.Serializable
getPersistentUserData()
The getPersistentUserData method returns a persistent data object belonging to the current step.Properties
getProperties()
The getProperties method returns the step level properties specified in a job definition.long
getStepExecutionId()
The getStepExecutionId method returns the current step's execution id.String
getStepName()
Get step nameObject
getTransientUserData()
The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.void
setExitStatus(String status)
The setExitStatus method assigns the user-specified exit status for the current step.void
setPersistentUserData(Serializable data)
The setPersistentUserData method stores a persistent data object into the current step.void
setTransientUserData(Object data)
The setTransientUserData method stores a transient data object into the current batch context.
-
-
-
Method Detail
-
getStepName
String getStepName()
Get step name- Returns:
- value of 'id' attribute from
-
getTransientUserData
Object getTransientUserData()
The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.- Returns:
- user-specified type
-
setTransientUserData
void setTransientUserData(Object data)
The setTransientUserData method stores a transient data object into the current batch context.- Parameters:
data
- is the user-specified type
-
getStepExecutionId
long getStepExecutionId()
The getStepExecutionId method returns the current step's execution id.- Returns:
- step execution id
-
getProperties
Properties getProperties()
The getProperties method returns the step level properties specified in a job definition.- Returns:
- job level properties
-
getPersistentUserData
Serializable getPersistentUserData()
The getPersistentUserData method returns a persistent data object belonging to the current step. The user data type must implement java.util.Serializable. This data is saved as part of a step's checkpoint. For a step that does not do checkpoints, it is saved after the step ends. It is available upon restart.- Returns:
- user-specified type
-
setPersistentUserData
void setPersistentUserData(Serializable data)
The setPersistentUserData method stores a persistent data object into the current step. The user data type must implement java.util.Serializable. This data is saved as part of a step's checkpoint. For a step that does not do checkpoints, it is saved after the step ends. It is available upon restart.- Parameters:
data
- is the user-specified type
-
getBatchStatus
BatchStatus getBatchStatus()
The getBatchStatus method returns the current batch status of the current step. This value is set by the batch runtime and changes as the batch status changes.- Returns:
- batch status string
-
getExitStatus
String getExitStatus()
The getExitStatus method simply returns the exit status value stored into the step context through the setExitStatus method or null.- Returns:
- exit status string
-
setExitStatus
void setExitStatus(String status)
The setExitStatus method assigns the user-specified exit status for the current step. When the step ends, the exit status of the step is the value specified through setExitStatus. If setExitStatus was not called or was called with a null value, then the exit status defaults to the batch status of the step.
-
getException
Exception getException()
The getException method returns the last exception thrown from a step level batch artifact to the batch runtime.- Returns:
- the last exception
-
getMetrics
Metric[] getMetrics()
The getMetrics method returns an array of step level metrics. These are things like commits, skips, etc.- Returns:
- metrics array
- See Also:
for definition of standard metrics.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 18/08/2025
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-javaee-rf-javax/batch/runtime/context/StepContext.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor dieser Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.