Sun Java System Portal Server 7 Developer's Guide

Filtering SOIF Objects

To support targeted parsing and printing, you can use the attribute filtering mechanisms in the SOIF stream. For each SOIF stream object, you can associate a list of allowed attributes. When printing a SOIF stream, only the attributes that match the allowed attributes will be printed. When parsing a SOIF stream, only the attributes that match the allowed attributes will be parsed.

SOIFStream_IsAllowed() and SOIFStream_SetAllowed() allow attributes, while SOIFStream_IsDenied() and SOIFStream_SetDenied() deny attributes. You can allow or deny an attribute, but not both.

SOIFStream_IsAllowed
NSAPI_PUBLIC boolean_t SOIFStream_IsAllowed(SOIFStream *ss, char *attribute);

Indicates that the given attribute is allowed (that is, it can be printed or parsed).

SOIFStream_SetAllowed
NSAPI_PUBLIC int SOIFStream_SetAllowed(SOIFStream *ss, char *allowed_attrs[])

Sets all the attributes in the allowed_attrs array to allowed.

SOIFStream_SetDenied
NSAPI_PUBLIC int SOIFStream_SetDenied(SOIFStream *ss, char *denied_attrs[]);

Sets all the attributes in the allowed_attrs array to be denied (that is, they cannot be parsed or printed).

SOIFStream_GetAllowed
NSAPI_PUBLIC char **SOIFStream_GetAllowed(SOIFStream *ss)

Returns an array of all the attributes that are allowed.

SOIFStream_GetDenied
NSAPI_PUBLIC char **SOIFStream_GetDenied(SOIFStream *ss);

Returns an array of all the attributes that are denied.