Package com.boomi.connector.api
Interface ProfileSchema
-
- All Superinterfaces:
AutoCloseable,Closeable
- All Known Implementing Classes:
SimpleProfileSchema
public interface ProfileSchema extends Closeable
Represents a schema definition for connector operations, providing access to schema content and metadata. This interface extends Closeable to ensure proper resource management when working with schema streams. Schema instances are typically used to define the structure and format of data exchanged through connector operations, enabling proper data validation and transformation within the Boomi integration platform.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InputStreamgetSchema()Retrieves the schema content as an input stream.ContentTypegetType()Gets the content type of the schema profile associated with the operation.
-
-
-
Method Detail
-
getSchema
InputStream getSchema()
Retrieves the schema content as an input stream. The returned stream contains the actual schema definition (e.g., XSD, JSON Schema) that describes the structure of data for the associated connector profile. Callers of this method are responsible for properly closing the returned InputStream to prevent resource leaks. Use try-with-resources or ensure close() is called in a finally block.- Returns:
- an InputStream containing the schema content, or null if data associated with the schema could not be retrieved.
-
getType
ContentType getType()
Gets the content type of the schema profile associated with the operation. The content type indicates the format and structure of the schema, which helps the platform determine how to process and validate data according to this schema. ReturnsContentType.NONEif the type is not xml or json- Returns:
- the
ContentTypeof the profile associated with this schema
-
-