com.liferay.portal.kernel.sanitizer
Class BaseSanitizer
java.lang.Object
com.liferay.portal.kernel.sanitizer.BaseSanitizer
- All Implemented Interfaces:
- Sanitizer
public abstract class BaseSanitizer
- extends Object
- implements Sanitizer
|
Method Summary |
byte[] |
sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
byte[] bytes,
Map<String,Object> options)
Returns the sanitized content as a byte array. |
void |
sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
InputStream inputStream,
OutputStream outputStream,
Map<String,Object> options)
Sanitizes the input stream content, assigning the results to the output
stream. |
abstract String |
sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
String content,
Map<String,Object> options)
Returns the sanitized content as a string. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BaseSanitizer
public BaseSanitizer()
sanitize
public byte[] sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
byte[] bytes,
Map<String,Object> options)
throws SanitizerException
- Description copied from interface:
Sanitizer
- Returns the sanitized content as a byte array. Implementations may modify
the input byte array.
- Specified by:
sanitize in interface Sanitizer
- Parameters:
companyId - the primary key of the portal instancegroupId - the primary key of the site's groupuserId - the user who changed the contentclassName - the class name of the content model implementationclassPK - the primary key of the content to sanitize,
0 if not availablecontentType - the content type. For more information, see
ContentTypes.modes - ways in which to run the sanitizer, such as Sanitizer.MODE_ALL, Sanitizer.MODE_BAD_WORDS, and/or Sanitizer.MODE_XSSbytes - the content to be sanitizedoptions - a map of options for the sanitizer
- Returns:
- the sanitized content
- Throws:
SanitizerException - if a sanitizer exception occurred
sanitize
public void sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
InputStream inputStream,
OutputStream outputStream,
Map<String,Object> options)
throws SanitizerException
- Description copied from interface:
Sanitizer
- Sanitizes the input stream content, assigning the results to the output
stream.
- Specified by:
sanitize in interface Sanitizer
- Parameters:
companyId - the primary key of the portal instancegroupId - the primary key of the site's groupuserId - the user who changed the contentclassName - the class name of the content model implementationclassPK - the primary key of the content to sanitize,
0 if not availablecontentType - the content type. For more information, see
ContentTypes.modes - ways in which to run the sanitizer, such as Sanitizer.MODE_ALL, Sanitizer.MODE_BAD_WORDS, and/or Sanitizer.MODE_XSSinputStream - the content to be sanitizedoutputStream - the result of the sanitizing processoptions - a map of options for the sanitizer
- Throws:
SanitizerException - if a sanitizer exception occurred
sanitize
public abstract String sanitize(long companyId,
long groupId,
long userId,
String className,
long classPK,
String contentType,
String[] modes,
String content,
Map<String,Object> options)
throws SanitizerException
- Description copied from interface:
Sanitizer
- Returns the sanitized content as a string.
- Specified by:
sanitize in interface Sanitizer
- Parameters:
companyId - the primary key of the portal instancegroupId - the primary key of the site's groupuserId - the user who changed the contentclassName - the class name of the content model implementationclassPK - the primary key of the content to sanitize,
0 if not availablecontentType - the content type. For more information, see ContentTypes.modes - ways in which to run the sanitizer, such as Sanitizer.MODE_ALL, Sanitizer.MODE_BAD_WORDS, and/or Sanitizer.MODE_XSScontent - the content to sanitizeoptions - the options map
- Returns:
- the sanitized content
- Throws:
SanitizerException - if a sanitizer exception occurred