jdk.jfr.internal.MetadataRepository Java Examples

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

public static List<EventType> getEventTypes() {
    // would normally be checked when a Flight Recorder instance is created
    Utils.checkAccessFlightRecorder();
    if (JVMSupport.isNotAvailable()) {
        return new ArrayList<>();
    }
    JDKEvents.initialize(); // make sure JDK events are available
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

/**
 * Unregisters an event class.
 * <p>
 * If the event class is not registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to unregistered, not {@code null}
 * @throws IllegalArgumentException if a class is abstract or not a subclass
 *         of {@link Event}
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void unregister(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Returns the event type for an event class, or {@code null} if it doesn't
 * exist.
 *
 * @param eventClass the event class, not {@code null}
 * @return the event class, or null if class doesn't exist
 *
 * @throws IllegalArgumentException if {@code eventClass} is an abstract class
 *
 * @throws IllegalStateException if the class is annotated with
 *         {@code Registered(false)}, but not manually registered
 */
public static EventType getEventType(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    Utils.ensureValidEventSubclass(eventClass);
    JVMSupport.ensureWithInternalError();
    return MetadataRepository.getInstance().getEventType(eventClass);
}
 

/**
 * Unregisters an event class.
 * <p>
 * If the event class is not registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to unregistered, not {@code null}
 * @throws IllegalArgumentException if a class is abstract or not a subclass
 *         of {@link Event}
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void unregister(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Registers an event class.
 * <p>
 * If the event class is already registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to register, not {@code null}
 *
 * @throws IllegalArgumentException if class is abstract or not a subclass
 *         of {@link Event}
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void register(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().register(eventClass);
}
 

/**
 * Returns the event type for an event class, or {@code null} if it doesn't
 * exist.
 *
 * @param eventClass the event class, not {@code null}
 * @return the event class, or null if class doesn't exist
 *
 * @throws IllegalArgumentException if {@code eventClass} is an abstract class
 *
 * @throws IllegalStateException if the class is annotated with
 *         {@code Registered(false)}, but not manually registered
 */
public static EventType getEventType(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    Utils.ensureValidEventSubclass(eventClass);
    JVMSupport.ensureWithInternalError();
    return MetadataRepository.getInstance().getEventType(eventClass);
}
 

/**
 * Unregisters an event class.
 * <p>
 * If the event class is not registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to unregistered, not {@code null}
 * @throws IllegalArgumentException if a class is abstract or not a subclass
 *         of {@link Event}
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void unregister(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Registers an event class.
 * <p>
 * If the event class is already registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to register, not {@code null}
 *
 * @throws IllegalArgumentException if class is abstract or not a subclass
 *         of {@link Event}
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void register(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().register(eventClass);
}
 

/**
 * Returns the event type for an event class, or {@code null} if it doesn't
 * exist.
 *
 * @param eventClass the event class, not {@code null}
 * @return the event class, or null if class doesn't exist
 *
 * @throws IllegalArgumentException if {@code eventClass} is an abstract class
 *
 * @throws IllegalStateException if the class is annotated with
 *         {@code Registered(false)}, but not manually registered
 */
public static EventType getEventType(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    Utils.ensureValidEventSubclass(eventClass);
    JVMSupport.ensureWithInternalError();
    return MetadataRepository.getInstance().getEventType(eventClass);
}
 

/**
 * Registers an event class.
 * <p>
 * If the event class is already registered, then the invocation of this method is
 * ignored.
 *
 * @param eventClass the event class to register, not {@code null}
 *
 * @throws IllegalArgumentException if class is abstract or not a subclass
 *         of {@link Event}
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 */
public static void register(Class<? extends Event> eventClass) {
    Objects.requireNonNull(eventClass);
    if (JVMSupport.isNotAvailable()) {
        return;
    }
    Utils.ensureValidEventSubclass(eventClass);
    MetadataRepository.getInstance().register(eventClass);
}
 

/**
 * Returns an immutable list that contains all currently registered events.
 * <p>
 * By default, events are registered when they are first used, typically
 * when an event object is allocated. To ensure an event is visible early,
 * registration can be triggered by invoking the
 * {@link FlightRecorder#register(Class)} method.
 *
 * @return list of events, not {@code null}
 */
public List<EventType> getEventTypes() {
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

/**
 * Registers an unregistered event.
 * <p>
 * By default, the event class associated with this event factory is registered
 * when the event factory is created, unless the event has the
 * {@link Registered} annotation.
 * <p>
 * A registered event class can write data to Flight Recorder and event metadata
 * can be obtained by invoking {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is already registered,
 * the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#register(Class)
 */
public void register() {
    MetadataRepository.getInstance().register(eventClass, sanitizedAnnotation, sanitizedFields);
}
 

/**
 * Unregisters the event that is associated with this event factory.
 * <p>
 * A unregistered event class can't write data to Flight Recorder and event
 * metadata can't be obtained by invoking
 * {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is not already
 * registered, the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#unregister(Class)
 */
public void unregister() {
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Unregisters the event that is associated with this event factory.
 * <p>
 * A unregistered event class can't write data to Flight Recorder and event
 * metadata can't be obtained by invoking
 * {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is not already
 * registered, the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#unregister(Class)
 */
public void unregister() {
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Registers an unregistered event.
 * <p>
 * By default, the event class associated with this event factory is registered
 * when the event factory is created, unless the event has the
 * {@link Registered} annotation.
 * <p>
 * A registered event class can write data to Flight Recorder and event metadata
 * can be obtained by invoking {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is already registered,
 * the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#register(Class)
 */
public void register() {
    MetadataRepository.getInstance().register(eventClass, sanitizedAnnotation, sanitizedFields);
}
 

/**
 * Returns an immutable list that contains all currently registered events.
 * <p>
 * By default, events are registered when they are first used, typically
 * when an event object is allocated. To ensure an event is visible early,
 * registration can be triggered by invoking the
 * {@link FlightRecorder#register(Class)} method.
 *
 * @return list of events, not {@code null}
 */
public List<EventType> getEventTypes() {
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}
 

/**
 * Registers an unregistered event.
 * <p>
 * By default, the event class associated with this event factory is registered
 * when the event factory is created, unless the event has the
 * {@link Registered} annotation.
 * <p>
 * A registered event class can write data to Flight Recorder and event metadata
 * can be obtained by invoking {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is already registered,
 * the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller
 *         does not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#register(Class)
 */
public void register() {
    MetadataRepository.getInstance().register(eventClass, sanitizedAnnotation, sanitizedFields);
}
 

/**
 * Unregisters the event that is associated with this event factory.
 * <p>
 * A unregistered event class can't write data to Flight Recorder and event
 * metadata can't be obtained by invoking
 * {@link FlightRecorder#getEventTypes()}.
 * <p>
 * If the event class associated with this event factory is not already
 * registered, the call to this method is ignored.
 *
 * @throws SecurityException if a security manager exists and the caller does
 *         not have {@code FlightRecorderPermission("registerEvent")}
 * @see Registered
 * @see FlightRecorder#unregister(Class)
 */
public void unregister() {
    MetadataRepository.getInstance().unregister(eventClass);
}
 

/**
 * Returns an immutable list that contains all currently registered events.
 *
 * By default, events are registered when they are first used, typically
 * when an event object is allocated. To ensure an event is visible early,
 * registration can be triggered by invoking the
 * {@link FlightRecorder#register(Class)} method.
 *
 * @return list of events, not {@code null}
 */
public List<EventType> getEventTypes() {
    return Collections.unmodifiableList(MetadataRepository.getInstance().getRegisteredEventTypes());
}